Skip to content

Commit 76545e7

Browse files
authored
[Improvement-17426][docs] Complete and fix mistakes in development md (#17427)
1 parent dc8a5a8 commit 76545e7

4 files changed

Lines changed: 26 additions & 10 deletions

File tree

‎docs/docs/en/contribute/development-environment-setup.md‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ Before setting up the DolphinScheduler development environment, please make sure
77
- [Git](https://git-scm.com/downloads)
88
- [JDK](https://www.oracle.com/technetwork/java/javase/downloads/index.html): v1.8+
99
- [Maven](http://maven.apache.org/download.cgi): v3.5+
10-
- [Node](https://nodejs.org/en/download): v16.13+ (dolphinScheduler version is lower than 3.0, please install node v12.20+)
11-
- [Pnpm](https://pnpm.io/installation): v6.x
10+
- [Node](https://nodejs.org/en/download): v16.0+
11+
- [Pnpm](https://pnpm.io/installation): v8.0+ (Make sure pnpm is compatible with Node.js, see also: [Compatibility](https://pnpm.io/installation#compatibility))
1212

1313
### Clone Git Repository
1414

@@ -155,6 +155,14 @@ Install frontend dependencies and run it.
155155

156156
> Note: You can see more detail about the frontend setting in [frontend development](./frontend-development.md).
157157
158+
If you have not yet installed `pnpm`, you can install it using the following command before running the front-end component:
159+
160+
```shell
161+
npm install -g pnpm
162+
```
163+
164+
After ensuring that `pnpm` has been installed, run the following command:
165+
158166
```shell
159167
cd dolphinscheduler-ui
160168
pnpm install

‎docs/docs/en/contribute/frontend-development.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,11 @@ Use the command line mode `cd` enter the `dolphinscheduler-ui` project director
3636
npm config set registry http://registry.npmmirror.com/
3737
```
3838

39-
- Modify `API_BASE` in the file `dolphinscheduler-ui/.env` to interact with the backend:
39+
- Modify `VITE_APP_DEV_WEB_URL` in the file `dolphinscheduler-ui/.env.development` to interact with the backend:
4040

4141
```
4242
# back end interface address
43-
API_BASE = http://127.0.0.1:12345
43+
VITE_APP_DEV_WEB_URL = 'http://127.0.0.1:12345'
4444
```
4545

4646
##### ! ! ! Special attention here. If the project reports a "node-sass error" error while pulling the dependency package, execute the following command again after execution.
@@ -53,7 +53,7 @@ npm install node-sass --unsafe-perm #Install node-sass dependency separately
5353

5454
#### Development environment operation
5555

56-
- `npm start` project development environment (after startup address http://localhost:8888)
56+
- `pnpm run dev` project development environment (after startup address http://localhost:8888)
5757

5858
#### Front-end project release
5959

‎docs/docs/zh/contribute/development-environment-setup.md‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@
77
* [Git](https://git-scm.com/downloads)
88
* [JDK](https://www.oracle.com/technetwork/java/javase/downloads/index.html): v1.8+
99
* [Maven](http://maven.apache.org/download.cgi): v3.5+
10-
* [Node](https://nodejs.org/en/download): v16.13+ (dolphinScheduler 版本低于 3.0, 请安装 node v12.20+)
11-
* [Pnpm](https://pnpm.io/installation): v6.x
10+
* [Node](https://nodejs.org/en/download): v16.0+
11+
* [Pnpm](https://pnpm.io/installation): v8.0+ (请确保不同版本的pnpm与Node.js之间是相互兼容的,可参考:[Compatibility](https://pnpm.io/installation#compatibility))
1212

1313
### 克隆代码库
1414

@@ -150,6 +150,14 @@ DolphinScheduler 开发环境配置有两个方式,分别是standalone模式
150150

151151
> 注意:你可以在[frontend development](./frontend-development.md)里查看更多前端的相关配置
152152
153+
在运行前端组件前,如果你还没有安装`pnpm`,可以使用以下命令安装:
154+
155+
```shell
156+
npm install -g pnpm
157+
```
158+
159+
确保`pnpm`已经安装完成后,运行以下命令:
160+
153161
```shell
154162
cd dolphinscheduler-ui
155163
pnpm install

‎docs/docs/zh/contribute/frontend-development.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,11 @@ Node包下载 (注意版本 v12.20.2) `https://nodejs.org/download/release/v12.2
3636
npm config set registry http://registry.npmmirror.com/
3737
```
3838

39-
- ���改 `dolphinscheduler-ui/.env` 文件中的 `API_BASE`,用于跟后端交互:
39+
- 修改 `dolphinscheduler-ui/.env.development` 文件中的 `VITE_APP_DEV_WEB_URL`,用于跟后端交互:
4040

4141
```
4242
# 代理的接口地址(自行修改)
43-
API_BASE = http://127.0.0.1:12345
43+
VITE_APP_DEV_WEB_URL = 'http://127.0.0.1:12345'
4444
```
4545

4646
##### !!!这里特别注意 项目如果在拉取依赖包的过程中报 " node-sass error " 错误,请在执行完后再次执行以下命令
@@ -53,7 +53,7 @@ npm install node-sass --unsafe-perm #单独安装node-sass依赖
5353

5454
#### 开发环境运行
5555

56-
- `npm start` 项目开发环境 (启动后访问地址 http://localhost:8888)
56+
- `pnpm run dev` 项目开发环境 (启动后访问地址 http://localhost:8888)
5757

5858
#### 前端项目发布
5959

0 commit comments

Comments
 (0)