Browse Source

更新说明文档

yanglzh 11 months ago
parent
commit
ed2232942f
3 changed files with 31 additions and 20 deletions
  1. 1 4
      .env.production
  2. 30 13
      README.md
  3. 0 3
      open.md

+ 1 - 4
.env.production

@@ -1,4 +1 @@
-VITE_SERVER_ORIGIN = ''
-
-VITE_RULE_SERVER_URL = '/rule/api/v1'
-VITE_MEDIA_SERVER_URL = '/media'
+VITE_SERVER_ORIGIN = ''

+ 30 - 13
README.md

@@ -6,28 +6,45 @@
 
 用 yarn 安装依赖
 
-1. 全局安装yarn: npm i yarn -g ,如果是非windows环境需要加 sudo
-2. 用yarn在项目中安装依赖: yarn i
+1. 全局安装 yarn: npm i yarn -g ,如果是非 windows 环境需要加 sudo
+2. 用 yarn 在项目中安装依赖: yarn i
 
 ### 环境变量配置
 
-**.env** 
+**.env**
 
-| 为默认环境配置,不可修改,会导致线上使用异常
-
-**.env.golocal**
-|为go直接运行环境配置,不可修改,会导致go直接运行异常
+为默认环境配置,不可修改,会导致使用异常。
 
 **.env.development**
 
-| 开发环境配置,可在此配置开发环境,开发使用时会覆盖默认配置
+开发环境配置,启动 `npm run dev` 会启动开发环境,配置为链接本地的 `go` 环境的配置,可按需更改。
 
-**.env.development.local**
+**.env.nginx**
 
-| 可在本地添加此文件进行配置,会覆盖默认配置及【.env.development】的配置,并且git会忽略这个文件,不会对其他的开发者的环境造成影响
+线上 `nignx` 部署情况下的演示配置,可以复制到 `.env.development` 中进行按需修改使用。
 
-如本地开发设置`.env.development.local`如:
+**.env.golocal**
 
-```shell
-VITE_SERVER_ORIGIN = 'http://127.0.0.1:8199'
+如需将打包后的静态文件放入到 `go` 服务中的 `public` 文件夹下使用,则需使用 `npm run build:golocal` 命令打包。
+
+**config.js**
+
+本地运行或打包都会根据 `env` 文件的配置,提前自动生成 `config.js` 配置文件,运行环境会在 `public` 目录下,打包之后会在生成的 `sagoo-iot` 目录下。可以通过手动修改这个 `config.js` 文件来修改前端运行时的服务端请求地址。通过修改配置来适应不同环境来避免调试时频繁打包。
+
+```javascript
+window.allEnv = {
+  "topo": {
+    "server": "/base-api/api/v1",
+    "imgServer": "/base-api"
+  },
+  "screen": {
+    "server": "/base-api/api/v1",
+    "imgServer": "/base-api"
+  },
+  "rule": {
+    "server": "/rule-api",
+    "iotServer": "/base-api/api/v1"
+  },
+  "media": "/media"
+}
 ```

+ 0 - 3
open.md

@@ -34,9 +34,6 @@
 | | |____notice
 | | |____online
 | |____config
-| |____assess
-| | |____totalIndex
-| | |____component
 | |____menu
 | |____task
 | |____api