Skip to content

Commit 9f2e04b

Browse files
committed
improve readme
1 parent f83988b commit 9f2e04b

File tree

2 files changed

+20
-18
lines changed

2 files changed

+20
-18
lines changed

README-zh.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,13 @@
3131
## 克隆项目
3232

3333
后端项目地址:[React-SpringBoot](https://github.com/zzh1991/React-SpringBoot)
34-
3534
前端项目地址:[movie-helper-front](https://github.com/zzh1991/movie-helper-front)
3635

36+
```bash
37+
# cd React-SpringBoot/
38+
git clone https://github.com/zzh1991/movie-helper-front.git
39+
```
40+
3741
## 🚀 使用
3842

3943
### 支持 Java 17 和 Spring Boot 3
@@ -87,13 +91,13 @@ spring:
8791

8892
#### 配置前端依赖
8993

90-
- `cd front`:切换到前端文件夹
91-
- `yarn`: 安装前端依赖
94+
- `cd movie-helper-front`:切换到前端文件夹
95+
- `npm install`: 安装前端依赖
9296
- 启动前端
9397
- 开发模式
94-
- `yarn start`
98+
- `npm run start`
9599
- 生产部署模式
96-
- `yarn deploy`
100+
- `npm run deploy`
97101
- 在 IDE 中启动应用
98102
- 打开浏览器
99103
- 开发模式: go to http://localhost:3000
@@ -102,12 +106,9 @@ spring:
102106
### 更新前端代码
103107

104108
```bash
105-
cd front
109+
cd movie-helper-front
106110
git fetch origin master
107111
git rebase origin/master
108-
109-
# or
110-
git submodule update --remote front
111112
```
112113

113114
## 生成 Java API 文档

README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,13 @@ Recently, I improved the performance from 50 to 90.
3535
## Git clone repo
3636

3737
Back-end project: [React-SpringBoot](https://github.com/zzh1991/React-SpringBoot)
38-
3938
Front-end project: [movie-helper-front](https://github.com/zzh1991/movie-helper-front)
4039

40+
```bash
41+
# cd React-SpringBoot/
42+
git clone https://github.com/zzh1991/movie-helper-front.git
43+
```
44+
4145
## 🚀 Usage
4246

4347
### Support Java 17 and Spring Boot 3
@@ -91,13 +95,13 @@ spring:
9195

9296
#### Configure Front
9397

94-
- `cd front`
95-
- `yarn`: install dependency
98+
- `cd movie-helper-front`
99+
- `npm install`: install dependency
96100
- prepare front static files
97101
- dev mode
98-
- `yarn start`
102+
- `npm run dev`
99103
- Deploy mode
100-
- `yarn deploy`
104+
- `npm run deploy`
101105
- start the web app in IDE
102106
- open browser
103107
- `dev mode`: go to http://localhost:3000
@@ -106,12 +110,9 @@ spring:
106110
### Update submodule for front end
107111

108112
```bash
109-
cd front
113+
cd movie-helper-front
110114
git fetch origin master
111115
git rebase origin/master
112-
113-
# or
114-
git submodule update --remote front
115116
```
116117

117118
## Java doc

0 commit comments

Comments
 (0)