https://github.com/fastapi-practices/fastapi_tortoise_mysql

fastapi + pydantic-v2 + tortoise-orm + aerich + mysql + redis
https://github.com/fastapi-practices/fastapi_tortoise_mysql

fastapi fastapi-template

Last synced: 8 months ago
JSON representation

fastapi + pydantic-v2 + tortoise-orm + aerich + mysql + redis

Host: GitHub
URL: https://github.com/fastapi-practices/fastapi_tortoise_mysql
Owner: fastapi-practices
License: mit
Created: 2022-03-20T08:15:44.000Z (almost 4 years ago)
Default Branch: master
Last Pushed: 2025-04-24T17:24:25.000Z (10 months ago)
Last Synced: 2025-04-30T11:53:56.824Z (10 months ago)
Topics: fastapi, fastapi-template
Language: Python
Homepage: https://fastapi-practices.github.io/fastapi_best_architecture_docs/guide/summary/fsm.html
Size: 191 KB
Stars: 42
Watchers: 2
Forks: 10
Open Issues: 3
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

README

# FastAPI Tortoise Architecture

## 本地开发

* Python 3.10+
* Mysql 8.0+
* Redis 推荐最新稳定版

1. 安装依赖项

```shell
pip install -r requirements.txt
```

2. 创建一个数据库 `ftm`, 选择 `utf8mb4` 编码
3. 安装启动 Redis
4. 进入 backend 目录

```shell
cd backend
```

5. 创建一个 `.env` 文件

```shell
touch .env
cp .env.example .env
```

6. 按需修改配置文件 `core/conf.py` 和 `.env`
7. 数据库迁移

```shell
# 初始化数据库，生成迁移文件
aerich init-db

# 执行迁移
aerich upgrade

# 当更新数据库 model 后，执行下面两个命令进行迁移
aerich migrate
aerich upgrade
```

8. 启动 fastapi 服务

```shell
# 帮助
fastapi --help

# 开发模式
fastapi dev main.py
```

9. 浏览器访问: http://127.0.0.1:8000/docs

---

### 2: docker

1. 进入 `docker-compose.yml` 文件所在目录，创建环境变量文件 `.env`

```shell
dcd deploy/docker-compose/

cp .env.server ../../../backend/.env
```

2. 执行一键启动命令

```shell
docker-compose up -d --build
```

3. 等待命令自动完成
4. 浏览器访问：http://127.0.0.1:8000/docs

## 赞助

如果此项目能够帮助到你，你可以赞助作者一些咖啡豆表示鼓励：[:coffee: Sponsor :coffee:](https://wu-clan.github.io/sponsor/)

## 许可证

本项目根据 MIT 许可证的条款进行许可