Browse Source

📃 docs: update README.md

Pchen. 8 months ago
parent
commit
b3490a0fb8
1 changed files with 47 additions and 45 deletions
  1. 47 45
      README.md

+ 47 - 45
README.md

@@ -126,6 +126,8 @@ npm install
 cp config-example.json config.json
 ```
 
+Double_X考勤系统使用企业微信登录接口,您需要前往企业微信管理页面添加应用并获取corpid、corpsecret、agentid等信息。
+
 #### 4.运行服务器
 
 ```
@@ -142,57 +144,57 @@ node index.js
 
 ##### 操作步骤:
 
-1. **克隆前端仓库**:
-   
-   ```bash
-   git clone https://git.vthc.cn/Pchen0/Double_X_Attendance_Web.git
-   ```
+**1.克隆前端仓库**:
 
-2. **安装依赖**:
-   
-   进入项目目录并安装项目依赖:
-   
-   ```bash
-   cd Double_X_Attendance_Web
-   npm install
-   ```
+```bash
+git clone https://git.vthc.cn/Pchen0/Double_X_Attendance_Web.git
+```
 
-3. **配置环境变量**:
-   
-   在项目根目录下创建并编辑 `.env` 文件,添加以下环境变量:
+**2.安装依赖**:
 
-   - `VITE_API_URL`:你的后端服务器地址
-   - `VITE_AMAP_KEY`:高德地图应用 Key
-   - `VITE_AMAP_HOST`:代理服务器地址,参考下面的Nginx反向代理配置进行反向代理设置
+进入项目目录并安装项目依赖:
 
-   *Nginx反向代理配置:*
+```bash
+cd Double_X_Attendance_Web
+npm install
+```
 
-   ```nginx
-     location /_AMapService/ {
-       set $args "$args&jscode=高德地图应用的安全密钥";
-       proxy_pass https://restapi.amap.com/;
-     }
-   ```
-   
-   保存相关配置之后需要通过命令nginx -s reload命令重新加载nginx配置文件。
-   
-   *示例 `.env` 文件内容:*
-   
-   ```env
-   VITE_API_URL=https://your-backend-server.com
-   VITE_AMAP_KEY=your-amap-key
-   VITE_AMAP_HOST=https://your-proxy-server.com
-   ```
-   
-4. **编译前端页面**:
-   
-   使用以下命令编译前端页面:
-   
-   ```bash
-   npm run build
-   ```
+**3.配置环境变量**:
+
+在项目根目录下创建并编辑 `.env` 文件,添加以下环境变量:
+
+- `VITE_API_URL`:你的后端服务器地址
+- `VITE_AMAP_KEY`:高德地图应用 Key
+- `VITE_AMAP_HOST`:代理服务器地址,参考下面的Nginx反向代理配置进行反向代理设置
+
+*Nginx反向代理配置:*
+
+```nginx
+  location /_AMapService/ {
+    set $args "$args&jscode=高德地图应用的安全密钥";
+    proxy_pass https://restapi.amap.com/;
+  }
+```
+
+保存相关配置之后需要通过命令nginx -s reload命令重新加载nginx配置文件。
+
+*示例 `.env` 文件内容:*
+
+```env
+VITE_API_URL=https://your-backend-server.com
+VITE_AMAP_KEY=your-amap-key
+VITE_AMAP_HOST=https://your-proxy-server.com
+```
+
+**4.编译前端页面**:
+
+使用以下命令编译前端页面:
+
+```bash
+npm run build
+```
 
-   该命令将生成用于生产环境的优化过的静态文件。
+该命令将生成用于生产环境的优化过的静态文件。
 
 ## 💡使用手册