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
NoahLan 5ef6da5b53 chore: add helper scripts for project commands 2 weeks ago
..
migrations refactor: rebuild fastapi framework foundation 2 weeks ago
scripts chore: add helper scripts for project commands 2 weeks ago
tests refactor: rebuild fastapi framework foundation 2 weeks ago
{{ project_slug }} refactor: rebuild fastapi framework foundation 2 weeks ago
.gitignore refactor: 重构框架项目,轻量微服务+copier+底包仓库依赖方式,而非代码直接进入 3 weeks ago
README.md.jinja chore: add helper scripts for project commands 2 weeks ago
app.py.jinja refactor: rebuild fastapi framework foundation 2 weeks ago
config.py.jinja refactor: rebuild fastapi framework foundation 2 weeks ago
copier.yml refactor: rebuild fastapi framework foundation 2 weeks ago
pyproject.toml.jinja refactor: rebuild fastapi framework foundation 2 weeks ago

README.md.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 }}

FastAPI 业务后端项目。
由 iTi-Flask Copier 模板生成。

## 依赖

默认使用私有 Git 依赖。
推荐固定 tag也允许 branch。
`file://` 只建议框架开发者本机验证模板时使用。

## 初始化

```bash
./scripts/app.sh init
```

Windows

```bat
scripts\app.cmd init
```

{% if include_system %}
同步系统 migration 和 seed

```bash
./scripts/app.sh init-system
```

Windows

```bat
scripts\app.cmd init-system
```
{% endif %}

## 开发

```bash
./scripts/app.sh serve 8000
./scripts/app.sh test
```

## 数据库迁移

```bash
./scripts/app.sh migration "alice add example table"
./scripts/app.sh migrate
```

规则:

- `migrations/versions` 必须提交。
- migration message 第一个词写作者名。
- 生产只从 `main` 执行 `alembic upgrade head`。