diff --git a/docs/en/develop/dev-config.md b/docs/en/develop/dev-config.md index 77d3e10a2..05f98f418 100644 --- a/docs/en/develop/dev-config.md +++ b/docs/en/develop/dev-config.md @@ -35,10 +35,19 @@ npm install Start debugging +- Usage in Linux and other environments + ```bash npm run dev:local ``` +- Usage in Windows environments + +```bash +npm run dev:local:win +``` + + :::info When using `dev:local` to start locally, the environment variable `NEXT_PUBLIC_API_BASE_URL` will be automatically used by the frontend to ensure that the frontend can access the `5300` port of the locally running backend. If you need to modify the backend address or port used, please modify the `scripts` in the `web/package.json` file. @@ -47,4 +56,4 @@ In production environments, the frontend will be precompiled into static files a ## API Documentation -We will write API documentation in APIFox before developing each interface. Please refer to [API Documentation(Chinese)](https://ok52vhsenr.apifox.cn/). \ No newline at end of file +We will write API documentation in APIFox before developing each interface. Please refer to [API Documentation(Chinese)](https://ok52vhsenr.apifox.cn/). diff --git a/docs/zh/develop/dev-config.md b/docs/zh/develop/dev-config.md index d1dd0194f..a6b33aef2 100644 --- a/docs/zh/develop/dev-config.md +++ b/docs/zh/develop/dev-config.md @@ -35,10 +35,18 @@ npm install 启动调试 +- linux等环境使用 + ```bash npm run dev:local ``` +- windows环境使用 + +```bash +npm run dev:local:win +``` + :::info 本地使用`dev:local`启动时,会携带环境变量`NEXT_PUBLIC_API_BASE_URL`,该变量会自动被前端使用,以确保前端可以访问到本地启动的后端的`5300`端口。如果您需要修改所使用的后端地址或端口,请到`web/package.json`文件中修改`scripts`中的`dev:local`命令。 @@ -47,4 +55,4 @@ npm run dev:local ## API 文档 -我们在开发每个接口之前都会先在 APIFox 中编写接口文档,请查看 [API 文档](https://ok52vhsenr.apifox.cn/)。 \ No newline at end of file +我们在开发每个接口之前都会先在 APIFox 中编写接口文档,请查看 [API 文档](https://ok52vhsenr.apifox.cn/)。