forked from Lesin/reposync
Update Documentation.md
This commit is contained in:
parent
916f8a69e9
commit
f41dfbcf4b
|
@ -1,12 +1,38 @@
|
||||||
## clone 仓库
|
### 依赖
|
||||||
|
|
||||||
- pip3 install -r requirement.txt
|
name|version|necessity
|
||||||
|
--|:--:|--:
|
||||||
|
python|3.9|True
|
||||||
|
uvicorn|0.14.0|True
|
||||||
|
SQLAlchemy|1.4.21|True
|
||||||
|
fastapi|0.66.0|True
|
||||||
|
aiohttp|3.7.4|True
|
||||||
|
pydantic|1.8.2|True
|
||||||
|
starlette|0.14.2|True
|
||||||
|
aiomysql|0.0.21|True
|
||||||
|
requests|2.25.1|True
|
||||||
|
loguru|0.6.0|True
|
||||||
|
typing-extensions|4.1.1|True
|
||||||
|
aiofiles|0.8.0|True
|
||||||
|
|
||||||
## 部署数据库
|
### 如何安装
|
||||||
|
|
||||||
|
> [!NOTE]
|
||||||
|
> 运行代码必须在python 3.9环境下面
|
||||||
|
|
||||||
|
`pip3 install -r requirement.txt`
|
||||||
|
|
||||||
|
### 部署数据库
|
||||||
|
|
||||||
- 创建一个自己的database
|
- 创建一个自己的database
|
||||||
- 仓库目录下的 sql/20240408.sql 文件已列出需要在数据库中创建的表结构
|
- 仓库目录下的 sql/20240408.sql 文件已列出需要在数据库中创建的表结构
|
||||||
- 设置自己的数据库连接串在src/base/config.py文件内,DB 变量的 'test_env'
|
- 设置自己的数据库连接串在src/base/config.py文件内
|
||||||
|
DB 变量的 ‘test_env’配置数据库参数
|
||||||
|
`'host': 数据库服务器的主机名或IP地址。可以通过环境变量 'CEROBOT_MYSQL_HOST' 获取其值,也可以自己设置。`
|
||||||
|
`'port': 数据库服务器的端口号。可以通过环境变量 'CEROBOT_MYSQL_PORT' 获取其值, 默认端口号‘2883’。`
|
||||||
|
`'user': 连接数据库的用户名。可以通过环境变量 'CEROBOT_MYSQL_USER' 获取其值,也可以自己设置。`
|
||||||
|
`'passwd': 连接数据库的密码。可以通过环境变量 'CEROBOT_MYSQL_PWD' 获取其值,也可以自己设置。`
|
||||||
|
`'dbname': 要连接的数据库的名称。可以通过环境变量 'CEROBOT_MYSQL_DB' 获取其值,也可以自己设置。`
|
||||||
|
|
||||||
## 启动服务
|
## 启动服务
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue