docs: update front docs

traas-stack · May 11, 2023 · dfea226 · dfea226
1 parent a7a9196
commit dfea226
Show file tree

Hide file tree

Showing 3 changed files with 49 additions and 7 deletions.
diff --git a/docs/src/en/SUMMARY.md b/docs/src/en/SUMMARY.md
@@ -39,6 +39,7 @@
 - [Log](dev-guide/log/README.md)
 - [Front](dev-guide/front/README.md)
   - [Build](dev-guide/front/build.md)
+  - [Run](dev-guide/front/run.md)
 - [Internals](dev-guide/internals/README.md)
   - [Log multiline](dev-guide/internals/log-multiline.md)
   - [GPU](dev-guide/internals/gpu.md)

diff --git a/docs/src/en/dev-guide/front/build.md b/docs/src/en/dev-guide/front/build.md
@@ -2,15 +2,11 @@ Compile requirements:
 - node
 - yarn
 
-Install dependencies
-```bash
-yarn
-```
-
 Build dist
 ```bash
-yarn run build
+./scripts/front/build.sh
 ```
 
 Build result:
-- dist/
+- front/dist/: html/js/css/assets
+- front/dist.zip: the zip of `front/dist/`
diff --git a/docs/src/en/dev-guide/front/run.md b/docs/src/en/dev-guide/front/run.md
@@ -0,0 +1,45 @@
+Before you run the front-end code, you need to have a running HoloInsight backend, you can refer to [this document](../test/README.md#deployment-for-testing) to start a backend.
+
+Suppose the address of the backend is `http://xx.xx.xx.xx:12345`, you need to configure `./front/config/config.ts`:
+
+```ts
+export default defineConfig({
+  ...
+  proxy: {
+    '/webapi/': {
+      target: 'http://xx.xx.xx.xx:12345',
+      changeOrigin: true,
+    },
+  }
+  ...
+});
+```
+
+Run front dev server:
+```bash
+cd front/ && yarn run dev
+```
+
+Example output:
+```text
+$yarn run dev
+yarn run v1.22.19
+$ max dev
+info  - Umi v4.0.68
+info  - Preparing...
+info  - MFSU eager strategy enabled
+[HPM] Proxy created: /webapi/  -> http://xx.xx.xx.xx:12345
+event - [MFSU][eager] start build deps
+info  - [MFSU] buildDeps since cacheDependency has changed
+        ╔════════════════════════════════════════════════════╗
+        ║ App listening at:                                  ║
+        ║  >   Local: http://localhost:8000                  ║
+ready - ║  > Network: http://xx.xx.xx.xx:8000                ║
+        ║                                                    ║
+        ║ Now you can open browser with the above addresses↑ ║
+        ╚════════════════════════════════════════════════════╝
+info  - [MFSU][eager] worker init, takes 562ms
+...
+```
+
+Visit the front pages at `http://xx.xx.xx.xx:8000`.