Skip to content
This repository was archived by the owner on Nov 10, 2025. It is now read-only.

Commit f49cef7

Browse files
committed
docs: update README with latest changes
1 parent c3453d1 commit f49cef7

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,31 +51,40 @@ Your generated project includes:
5151
Once your project is created, you can run:
5252

5353
### `npm run dev`
54+
5455
Starts the development server with:
56+
5557
- Docker-based proof server on port 6300
5658
- File watcher for automatic recompilation
5759
- Hot reloading for contract changes
5860

5961
### `npm run setup`
62+
6063
Complete setup pipeline:
64+
6165
1. Compiles Compact contracts
6266
2. Builds TypeScript to JavaScript
6367
3. Deploys contracts to the network
6468

6569
### `npm run cli`
70+
6671
Opens an interactive command-line interface to:
72+
6773
- Connect your wallet
6874
- Store messages in the contract
6975
- Retrieve stored messages
7076
- Test contract functionality
7177

7278
### `npm run compile`
79+
7380
Compiles your Compact smart contracts from `contracts/` to `contracts/managed/`
7481

7582
### `npm run build`
83+
7684
Builds your TypeScript source code to JavaScript in the `dist/` directory
7785

7886
### `npm run deploy`
87+
7988
Deploys your compiled contract to the Midnight testnet
8089

8190
## Project Structure
@@ -102,7 +111,9 @@ my-midnight-app/
102111
## Templates
103112

104113
### Hello World (Default)
114+
105115
A simple message storage contract demonstrating:
116+
106117
- State management
107118
- Public and private data
108119
- Contract deployment
@@ -166,7 +177,9 @@ PROOF_SERVER_URL=http://localhost:6300
166177
## Troubleshooting
167178

168179
### Port 6300 already in use
180+
169181
If you see "Bind for 0.0.0.0:6300 failed: port is already allocated":
182+
170183
```bash
171184
# Stop the existing proof server
172185
docker ps
@@ -176,14 +189,18 @@ docker stop <container-id>
176189
```
177190

178191
### Module resolution errors
192+
179193
Make sure you're using Node.js 18+ and the project was created with the latest version:
194+
180195
```bash
181196
node --version
182197
npx create-mn-app@latest my-app
183198
```
184199

185200
### Docker not running
201+
186202
Ensure Docker Desktop is running before starting the development server:
203+
187204
```bash
188205
docker --version
189206
```
@@ -206,4 +223,3 @@ MIT © [Olanetsoft](https://github.com/Olanetsoft)
206223
---
207224

208225
Built with ❤️ for the Midnight Network community 🌙✨
209-

0 commit comments

Comments
 (0)