Appearance
安装依赖环境
shell
pip install -r requirements.txt
初始化数据库
shell
aerich init-db
生成迁移文件
shell
aerich migrate
数据库迁移迁移
shell
aerich upgrade
项目开发说明
项目目录结构说明
shell
|____apps # 项目应用目录
| |____test
| | |______init__.py
| | |____models.py # 数据库模型
| | |____schemas.py # 数据库模型序列化
| | |____views.py # 视图函数
|____common # 项目公共目录
|____config # 项目配置目录
|____files # 项目文件目录
| |____.keep # 项目文件目录占位文件
|____migration # 数据库迁移目录
| |____.keep # 数据库迁移目录占位文件
|____project # 项目服务目录
| |______init__.py
| |____server.py # 项目启动文件
|____statics # 项目静态文件目录
| |____.keep # 项目静态文件目录占位文件
|____.env.example # 项目配置示例文件
|____.gitignore # git忽略文件
|____app.py # 项目运行文件
|____pyproject.toml # 项目数据库文件
|____readme.md # 项目说明文件
|____requirements.txt # 项目依赖文件
项目运行说明
运行时项目会自动发现apps目录下的应用，然后自动注册模型与视图方法，所以只需要在apps目录下创建应用即可，不需要在project目录下注册应用。
其中模型不限制文件，但是推荐编写在models.py文件中，视图函数限制文件，需要编写在views.py文件中，每个视图函数需要编写一个装饰器，装饰器的参数为路由地址，如下所示：
python
from project.server import app_router
@app_router.get("/test")
async def test():
return {"msg": "test"}
系统管理支持
本项目模板提供基本系统管理功能
开启该功能需要设置SYSTEM_SYSTEM_ALLOW为True，并迁移数据库
开启该功能后可以使用创建超级用户功能
创建超级用户
设置SYSTEM_SYSTEM_ALLOW为True，并迁移数据库，然后运行如下命令创建超级用户
shell
python app.py createsuperuser