diff --git a/README.md b/README.md
index 17093f7..5da2e0b 100644
--- a/README.md
+++ b/README.md
@@ -32,31 +32,11 @@
-## 使用技术栈
-
-项目开发环境:Windows 11 / Ubuntu Desktop 22.04 LTS、OpenJDK 11、MySQL 8.0.12、Node 14.18.0、Git(暂定)
-
-项目部署环境:Linux、MySQL 8.0.x、nacos(暂定)
-
-| 板块 | 技术栈 | 开发工具 | 依赖管理 | 备注 |
-| -------- | ------------------------------------------------------------ | ------------------------------------------------------------ | ----------- | ---- |
-| 前端 | Vue 3(JavaScript框架)、Element Plus(UI组件库) | VS Code(代码编辑器) | npm 8.19.2 | 暂定 |
-| 后端 | Java 11(开发语言)、SpringCloud(微服务)、nacos-server-2.1.2(服务注册与发现)、Redis(缓存) | Intellij IDEA Ultimate(集成开发环境)、
Postman(接口测试) | Maven 3.6.3 | |
-| 小程序端 | Taro 3.x(小程序跨端解决方案)、Vue 3(JavaScript框架) | VS Code(代码编辑器)、
微信开发者工具(微信小程序打包工具)、
小程序开发工具(支付宝小程序打包工具) | npm 8.19.2 | |
-| 门禁端 | Electron(跨平台桌面GUI应用开发)、Nodejs(JavaScript 运行时环境) | VS Code(代码编辑器) | npm 8.19.2 | |
-| 数据库 | MySQL 8.0.12(数据存储) | Navicat | - | |
-
-
-
-## 数据库设计
+## 数据库字典
> 微服务:一个服务对应一个数据库,同一个信息可能存在不同的数据库
-用户表
-
-人员进出日志表
-
-体温上报表
+TODO
@@ -83,188 +63,44 @@
### 一些说明
-微信小程序支付功能如果没有微信支付商户号无法开发&测试,我没有商户号,所以微信小程序的支付功能没有做兼容。
-
-支付宝小程序在沙箱环境下,可以测试完整的支付流程,所以支付宝小程序的开发全部在沙箱环境下进行(没有在线上支付宝环境测试过)。
+微信小程序支付功能如果没有微信支付商户号无法开发&测试,我没有商户号,所以微信小程序的支付功能是假的支付。
-## 启动项目
+## 环境配置(使用技术栈)
-### Step0. 启动前的准备
+### 安装运行环境
-#### 1.安装运行环境
+项目运行需要如下环境。[检查环境是否安装成功及国内镜像源配置](./docs/EnvCheck.md)
-##### 概览
-
-需要准备如下项目运行环境
-
-代码管理:[Git](https://git-scm.com/download)
-
-前端:[**Nodejs**](https://nodejs.org/zh-cn/),**npm**(安装node时会自带npm),[**Taro CLI**](https://taro-docs.jd.com/docs/GETTING-STARTED),Vue 3[ ](https://cn.vuejs.org/guide/quick-start.html)
-
-后端:[**OpenJDK 11**](https://jdk.java.net/java-se-ri/11)、[**Maven**](https://maven.apache.org/download.cgi)(需要配置JDK、Maven环境变量及Maven国内镜像源),[**nacos**](https://github.com/alibaba/nacos/releases/tag/2.1.2)
-
-数据库:[**MySQL 8.0.x**](https://downloads.mysql.com/archives/community/)、[Navicat](http://www.navicat.com.cn/products/navicat-premium)(需要激活,可使用其他数据库管理工具代替)
-
-小程序端:[**Taro**](https://taro-docs.jd.com/docs/GETTING-STARTED)
-
-门禁端:[**Electron**](https://www.electronjs.org/),[**cnpm**](https://npmmirror.com/)
-
-开发工具:[VSCode](https://code.visualstudio.com/#alt-downloads)(建议安装扩展:[EditorConfig for VS Code](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig);[Vue Language Features (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.volar))、[IDEA Ultimate](https://www.jetbrains.com/zh-cn/idea/download/)(需要激活)、[微信开发者工具](https://developers.weixin.qq.com/miniprogram/dev/devtools/download.html)、[小程序开发工具](https://opendocs.alipay.com/mini/ide/download)(需要安装 `沙箱环境切换插件` 扩展并重启工具)
-
-手机应用:[微信](https://weixin.qq.com/)(用于测试微信小程序)、[支付宝客户端沙箱版](https://open.alipay.com/develop/sandbox/tool/alipayclint)(用于测试支付宝小程序)
-
-接口测试工具:[Postman](https://www.postman.com/downloads/)
-
-> 如果希望查看环境变量是否配置成功,可以使用以下命令:
->
-> (下面以 Windows 下命令说明,Linux 系统下 `echo %变量名%` 需要改成 `echo $变量名`)
->
-> ```bash
-> echo %PATH%
-> # 您会看到以;分隔的很多路径,其中应该包括:
-> # JDK 所在文件夹下的 bin 目录:...\openjdk-11\bin
-> # Maven 所在文件夹下的 bin 目录:...\apache-maven-3.6.3\bin
->
-> echo %JAVA_HOME%
-> # 您会看到 JDK 所在文件夹
->
-> echo %MAVEN_HOME%
-> # 您会看到 Maven 所在文件夹
-> ```
->
-> 如果希望查看环境是否安装成功或安装的环境版本,可以使用以下命令:
->
-> ```bash
-> # 查看 Git 版本
-> git --version
-> # 您应该看到类似如下输出👇
-> # git version 2.35.1.windows.2
->
-> # 查看 MySQL 版本(如果 MySQL 的 bin 目录没有配在环境变量中,则需要先 cd 切换到 bin 目录下)
-> mysql --version
-> # 您应该看到类似如下输出👇
-> # mysql Ver 8.0.12 for Win64 on x86_64 (MySQL Community Server - GPL)
->
-> # 查看 JDK 版本
-> java -version
-> # 您应该看到类似如下输出👇
-> # openjdk version "11" 2018-09-25
-> # OpenJDK Runtime Environment 18.9 (build 11+28)
-> # OpenJDK 64-Bit Server VM 18.9 (build 11+28, mixed mode)
->
-> # 查看 Maven 版本
-> mvn -v
-> # 您应该看到类似如下输出👇
-> # Apache Maven 3.6.3 (cecedd343002696d0abb50b32b541b8a6ba2883f)
-> # Maven home: xxxxxx\apache-maven-3.6.3\bin\..
-> # Java version: 11, vendor: Oracle Corporation, runtime: xxxxxx\openjdk-11
-> # Default locale: zh_CN, platform encoding: GBK
-> # OS name: "windows 10", version: "10.0", arch: "amd64", family: "windows"
->
-> # 查看 node 版本
-> node -v
-> # 您应该看到类似如下输出👇
-> # v14.18.0
->
-> # 查看 npm 版本
-> npm -v
-> # 您应该看到类似如下输出👇
-> # 8.19.2
->
-> # 查看 cnpm 版本
-> cnpm -v
-> # 您应该看到类似如下输出👇
-> # cnpm@8.4.0 (C:\Users\Coz\AppData\Roaming\npm\node_modules\cnpm\lib\parse_argv.js)
-> # npm@8.19.2 (C:\Users\Coz\AppData\Roaming\npm\node_modules\cnpm\node_modules\npm\index.js)
-> # node@14.18.0 (D:\Program\Development\Environment\nodejs\node.exe)
-> # npminstall@6.5.2 (C:\Users\Coz\AppData\Roaming\npm\node_modules\cnpm\node_modules\npminstall\lib\index.js)
-> # prefix=C:\Users\Coz\AppData\Roaming\npm
-> # win32 x64 10.0.22621
-> # registry=https://registry.npmmirror.com
-> ```
->
-> Maven 镜像源配置(下面以阿里云镜像为例,其他镜像可自行替换):
->
-> 用编辑器打开 maven 目录下 conf/settings.xml 文件,找到如下位置,将 `
Ubuntu Desktop 22.04 LTS | 开发 | |
+| 系统 | | Ubuntu Server 22.04 LTS | 生产 | |
+| 环境 | 代码管理 | [Git](https://git-scm.com/download) | 开发 | 代码管理 |
+| 环境 | 前端 门禁端 | [**Node.js 14.18.0**](https://nodejs.org/zh-cn/) | 开发 生产 | 一个开源、跨平台的 JavaScript 运行时环境 |
+| 依赖管理 | 前端 门禁端 | **npm 9.5.1** | 开发 | 安装 node 时会自带 npm |
+| 环境 | 前端 | [Vue 3](https://cn.vuejs.org/guide/quick-start.html) | 开发 | 渐进式 JavaScript 框架 |
+| UI 组件库 | 前端 | [Element Plus](https://element-plus.gitee.io/zh-CN/) | 开发 | 一个Vue 3 UI 框架 |
+| 环境 | 门禁端 | [**cnpm**](https://npmmirror.com/) | 开发 | |
+| 环境 | 门禁端 | [**Electron**](https://www.electronjs.org/) | 开发 | 跨平台桌面 GUI 应用开发 |
+| 环境 | 后端 | [**OpenJDK 11**](https://jdk.java.net/java-se-ri/11) | 开发 生产 | **需要配置 JDK 环境变量**;Java 11 |
+| 依赖管理 | 后端 | [**Maven 3.6.3**](https://maven.apache.org/download.cgi) | 开发 生产 | **需要配置 Maven 环境变量、国内镜像源** |
+| 微服务框架 | 后端 | SpringCloud | 开发 生产 | 微服务 |
+| 环境 | 后端 | [**nacos server 2.2.0**](https://github.com/alibaba/nacos/releases/tag/2.2.0) | 开发 生产 | 微服务注册中心(服务注册与发现) |
+| 环境 | 服务端 | Nginx | 开发 生产 | 可选 |
+| 环境 | 数据库 | [**MySQL 8.0.x**](https://downloads.mysql.com/archives/community/) | 开发 生产 | 数据存储 |
+| 管理工具 | 数据库 | [Navicat](http://www.navicat.com.cn/products/navicat-premium) | 开发 | 可选;需要激活,可使用其他数据库管理工具代替 |
+| 开发工具 | 小程序端 | [微信开发者工具](https://developers.weixin.qq.com/miniprogram/dev/devtools/download.html) | 开发 | 微信小程序打包工具(小程序端为原生开发) |
+| 开发工具 | 前端 后端 | [VSCode](https://code.visualstudio.com/#alt-downloads) | 开发 | 代码编辑器。建议安装扩展:
[EditorConfig for VS Code](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig);
[Vue Language Features (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.volar) |
+| 开发工具 | 后端 | [Intellij IDEA Ultimate](https://www.jetbrains.com/zh-cn/idea/download/) | 开发 | 集成开发环境。需要激活 |
+| 小程序测试 | 手机应用 | [微信](https://weixin.qq.com/) | 开发 | 用于测试微信小程序 |
+| 接口测试 | 接口测试 | [Postman](https://www.postman.com/downloads/) | 开发 | 接口测试工具 |
+| | 后端 | Redis | | 缓存(待定) |
-##### cnpm
-
-```bash
-# electron 需要使用 cnpm 安装依赖
-npm install -g cnpm --registry=https://registry.npmmirror.com
-```
-
-
-
-##### Taro
-
-```bash
-npm install -g @tarojs/cli
-```
-
-
-
-##### Electron
-
-```bash
-cd client-entrance-guard
-cnpm install --save-dev electron
-cnpm install --save-dev @electron-forge/cli
-```
-
-
-
-#### 2.克隆项目代码到本地
+### 克隆项目代码到本地
```bash
# 克隆项目代码到本地
@@ -278,32 +114,43 @@ cd epp
-#### 3.数据库
+### 项目配置
+
+#### 导入数据库
导入数据库SQL(SQL文件在 `database` 目录下)
-#### 4.后端依赖
+#### 安装依赖
+
+代码克隆下来后,第一次需要安装依赖
```bash
+# ############
+# 后端依赖
+# ############
# 进入 backend 目录
cd backend
mvn clean install
# 回到项目根目录下
cd ../
-```
+# ############
+# 门禁端依赖
+# ############
+# Electron
+cd client-entrance-guard
+cnpm install
+# 回到项目根目录下
+cd ../
-
-#### 5.前端依赖
-
-代码克隆下来后,第一次需要安装依赖
-
-```bash
+# ############
+# 前端依赖
+# ############
# 进入 frontend 目录
cd frontend
-# 建议使用 cnpm 安装依赖,如果没有安装 cnpm,可以通过 npm i cnpm进行安装
+# 建议使用 cnpm 安装依赖,如果没有安装 cnpm,可以通过 npm i cnpm 进行安装
cnpm install
# npm install --legacy-peer-deps
# 回到项目根目录下
@@ -312,28 +159,20 @@ cd ../
-#### 6.小程序依赖
-
-```bash
-# 进入 miniprogram 目录
-cd miniprogram
-npm install
-# 回到项目根目录下
-cd ../
-```
-
-
-
-#### 7.小程序配置
+#### 小程序配置 & 打包
##### 配置业务域名
-1.修改 `miniprogram/src/app.js` 文件
+1.修改 `weixin-miniprogram/app.js` 文件
```javascript
-App.use(setGlobalDataPlugin, {
+// app.js
+App({
+ ...
globalData: {
- baseUrl: "⚠此处修改为你自己的后端地址。注意需要https://开头,最后不带/",
+ ...
+ baseUrl: "⚠此处修改为你的 Api 请求域名(不带最后的/)",
+ ...
}
})
```
@@ -342,9 +181,6 @@ App.use(setGlobalDataPlugin, {
- 小程序:在[微信小程序后台](https://mp.weixin.qq.com/) - 左侧最下方**开发** - **开发管理** - 右侧上方**开发设置** - **服务器域名** 添加 `https://` 开头的**request合法域名**
- 小程序测试号:在[微信小程序后台](https://mp.weixin.qq.com/) - **服务器域名** 添加 `https://` 开头的**request合法域名**(注意不是业务域名)
-- 支付宝沙箱应用:在[支付宝开放平台](https://open.alipay.com/develop/sandbox/app) - 左侧**沙箱应用** - **服务端域名白名单** 添加 `https://` 开头的**httpRequest接口请求域名白名单**
-
-
##### 配置微信小程序appid
@@ -354,7 +190,7 @@ App.use(setGlobalDataPlugin, {
>
> 如果已经注册过小程序,可以在此处微信扫码登录:https://mp.weixin.qq.com/ ,然后左侧菜单最后一项【设置】,滑到最下面【帐号信息】,AppID(小程序ID)一栏就是appid
-修改 `miniprogram/project.config.json` 文件
+修改 `weixin-miniprogram/project.config.json` 文件
```json
{
@@ -364,48 +200,34 @@ App.use(setGlobalDataPlugin, {
}
```
+##### 设置小程序最低基础库
+> 参考:https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/userProfile.html
-#### 8.小程序打包
+设置小程序最低基础库为 2.21.3 或更高
##### 打包微信小程序
-```bash
-cd miniprogram
-npm run build:weapp
+打开**微信开发者工具**,小程序目录选择 `weixin-miniprogram` 目录,按照正常的小程序发布流程进行发布即可。发布前记得测试小程序各功能是否正常。
+
+
+
+#### 门禁端配置 & 打包
+
+##### 配置业务域名
+
+修改 `client-entrance-guard/html/index.html` 文件
+
+```html
+...
+