Skip to content

Commit 3efa90b

Browse files
authored
docs: updates website instructions for development mode. (#213)
Closes usememos/memos#4918 Co-authored-by: aarohee-he <aarohee-he@users.noreply.github.com>
1 parent 4db29d1 commit 3efa90b

File tree

1 file changed

+25
-10
lines changed

1 file changed

+25
-10
lines changed

content/docs/contribution/development.md

Lines changed: 25 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,24 +15,39 @@ Memos is built with a curated tech stack. It is optimized for developer experien
1515

1616
## Steps
1717

18-
1. Clone the repo
18+
#### 1. Backend Development
1919

2020
```bash
21-
git clone https://github.com/usememos/memos
21+
# Clone the repository
22+
git clone https://github.com/usememos/memos.git
23+
cd memos
24+
25+
# Install Go dependencies
26+
go mod download
27+
28+
# Run the backend server
29+
go run ./bin/memos/main.go --mode dev --port 8081
2230
```
2331

24-
2. Build and run backend server
32+
#### 2. Frontend Development
2533

2634
```bash
27-
sh scripts/build.sh
35+
# Navigate to web directory
36+
cd web
37+
38+
# Install dependencies
39+
pnpm install
40+
41+
# Start development server
42+
pnpm dev
2843
```
2944

30-
After a successful build, run the server following the build outputs.
45+
The development servers will be available at:
3146

32-
3. Start frontend
47+
Backend API: http://localhost:8081
48+
Frontend: http://localhost:3001
3349

34-
```bash
35-
cd web && pnpm i && pnpm dev
36-
```
50+
The development servers will be available at:
3751

38-
Memos should now be running at <http://localhost:3001>.
52+
Backend API: `http://localhost:8081`
53+
Frontend: `http://localhost:3001`

0 commit comments

Comments
 (0)