You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
iTi-Flask/copier-template/README.md.jinja

55 lines
1.1 KiB
Django/Jinja

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

# {{ project_name }}
这是由 iTi-Flask Copier 模板生成的业务后端项目。
业务代码只扩展框架。
不要复制、覆盖或修改框架内部实现。
## 初始化
```bash
uv sync --extra dev
uv run python -m flask --app app.py iti migrations sync
uv run python -m flask --app app.py db upgrade
uv run python -m flask --app app.py iti seed system
```
## 开发
```bash
uv run python -m flask --app app.py run --debug
uv run --extra dev pytest
```
## 数据库迁移
生成 migration
```bash
uv run python -m flask --app app.py db migrate -m "alice add example table"
```
升级数据库:
```bash
uv run python -m flask --app app.py db upgrade
```
规则:
- `migrations/versions` 必须提交。
- migration message 第一个词写作者名,后面自由描述。
- 生产只从 `main` 执行 `flask db upgrade`。
- 框架升级后先执行 `flask iti migrations sync`。
## 种子数据
系统域数据由框架 seed 写入:
```bash
uv run python -m flask --app app.py iti seed system
```
业务 seed 放到业务项目自己的模块中。
不要把业务数据写进框架 seed。