summaryrefslogtreecommitdiff
path: root/server
diff options
context:
space:
mode:
authorhandingkang <[email protected]>2024-04-22 17:35:38 +0800
committerhandingkang <[email protected]>2024-04-22 17:35:38 +0800
commitdf5dfafc12281720faa68c57bcd4b966f559967c (patch)
tree7f671529cd4070187c06e9af30bc8639e24b7648 /server
parent3d3b8e07a34390f3941c17e5bdf92dfbadbdaee0 (diff)
同步说明文档信息
Diffstat (limited to 'server')
-rw-r--r--server/README.md24
1 files changed, 23 insertions, 1 deletions
diff --git a/server/README.md b/server/README.md
index 4b8b3e7..f81b547 100644
--- a/server/README.md
+++ b/server/README.md
@@ -2,7 +2,11 @@
## 简介
-主控端代码,运行app.py将启动一个flask服务,端口为2525。
+主控端代码,运行app.py将启动一个flask服务,默认端口为12525。
+包含三个分支:
+main分支,稳定版本
+dev分支,用于根据fake分支完善的接口定义开发实际业务逻辑
+fake分支,用于快速定义新的数据接口与前端对接
访问/docs可以看到swagger-api文档
@@ -16,3 +20,21 @@
| target.py | 目标感知 |
| task.py | 任务管理 |
+model.py文件包含了一些参数与数据库表字段名或类型之间的映射关系
+
+util.py 提供了访问数据库的工具类和日志输出函数
+
+## 部署过程
+
+1. 首先根据script.sql创建符合要求的数据库表,并在settings.py中配置对应的数据库连接选项
+2. 接下来使用pip 根据requirements.txt安装第三方环境依赖
+
+```shell
+pip install -r requirements.txt
+```
+
+3. 启动主控端服务
+
+```shell
+python app.py
+``` \ No newline at end of file