docs: 添加使用说明

This commit is contained in:
zhengxinonly
2023-10-31 21:53:30 +08:00
parent 7c07b6c94d
commit eee1bda795
2 changed files with 24 additions and 356 deletions
+22
View File
@@ -1,3 +1,25 @@
## 本地启动
环境要求:python 3.10 以上,安装了 poetry
初始化环境
```shell
poetry install
```
初始化数据库
```shell
flask init
```
启动
```shell
flask run
```
## 贡献指南
如果想参与项目的贡献,提交代码之前需要启用 pre-commit、commitizen 对代码进行校验,运行以下指令即可。