快速开始

约 1167 字大约 4 分钟

警告

FBA 仅适用于资深 Python 后端开发人员，如果您是非资深用户，请使用精简版

重要

我们建议新手用户从一些基础和简单的内容入手，这不仅是对自身学习的一种负责态度，也是为将来能够顺利掌握这一架构所奠定的坚实基础，欢迎加入我们的 Discord 社区进行讨论

最后，请认真对待此文档，并严格按照本文档的顺序启动项目，否则你有很大几率在启动过程中遇到各种问题

本地开发

后端

提示

如果你是 PostgreSQL 用户，请先移步到切换数据库

准备本地环境
- Python 3.10+
- MySQL 8.0+ 或 PostgreSQL 16.0 +
- Redis 推荐最新稳定版
准备 Git 仓库
相关信息
两种方案，选择其中一种即可
1. 拉取源代码仓库
  此方式需要你删除拉取项目后根目录下的 .git 文件夹，之后上传到你指定的仓库即可，具体请自行查阅你要上传平台的行为准则
```
git clone https://github.com/fastapi-practices/fastapi_best_architecture.git
```
2. 创建模板仓库
  此项目支持创建模板仓库，意味着，你可以直接创建一个非 fork（独立无绑定的关系）的个人仓库，如果所示，进入此项目 GitHub 首页，使用 use this template 按钮创建即可，创建完成之后，使用 git clone 命令拉取你自己的仓库即可
安装依赖包
拉取项目到本地后，进入项目 backend 目录，执行以下命令
```
pip install -r requirements.txt
```
创建数据库：fba，选择 utf8mb4 编码，postgres 用户可忽略编码
启动 Redis
env
在 backend 目录中，创建环境变量文件
```
touch .env
```
将初始化环境变量配置拷贝到环境变量文件中
```
cp .env.example .env
```
按需修改配置文件 core/conf.py 和 .env
创建数据库表（三选一）
- 直接启动后端项目（自动创建）
- 数据库迁移 alembic
  生成迁移文件
```
alembic revision --autogenerate
```
  执行迁移
```
alembic upgrade head
```
- 执行 backend/sql/ 目录下对应数据库的 create_tables.sql 脚本

启动 celery worker, beat 和 flower （可选）

Celery 应用程序

celery -A app.task.celery worker -l info

定时任务

celery -A app.task.celery beat -l info

web 监控

celery -A app.task.celery flower --port=8555 --basic-auth=admin:123456

初始化测试数据
执行 backend/sql/init_test_data.sql 脚本初始化测试数据
启动 fastapi 服务
注意
此项目默认使用 CLI 启动服务，为了方便本地调试，你仍然可以选择在 IDE 中右键运行 run.py 文件
如果你在项目中安装了独立 app 插件，请务必使用 run.py 启动项目，否则，您将收到启动错误，详情：fastapi/fastapi#13372 (comment)
帮助
```
fastapi --help
```
开发模式
```
fastapi dev main.py
```
打开浏览器访问：http://127.0.0.1:8000/docs

前端

提示

前端项目并不是我们发展的重心，我们创建的所有前端实施，均用于 UI 效果演示，它们不一定适用于生产环境，您可以点击查看我们的目标

Arco Desgin Vue

警告

这是一个实验性实施，它仅用作效果演示，而不是用于生产！

准备本地环境
- Nodejs 18.0+
- yarn 1.x

拉取 Git 项目

git clone https://github.com/fastapi-practices/fastapi_best_architecture_ui.git

安装和启动
注意
第一次启动可能会很慢，你可以查看此 Issue 查看详情
进入项目根目录，安装依赖
```
yarn install
```
启动
```
yarn dev
```

Vben Admin Antd

注意

这是下一代实施，目前正处于积极开发阶段

准备本地环境
- Nodejs 20.10.0+
- pnpm 9.12.0+

拉取 Git 项目

git clone https://github.com/fastapi-practices/fba_ui.git

安装和启动
进入项目根目录，安装依赖
```
pnpm install
```
启动
```
pnpm dev
```

开发流程

提示

仅供参考，实际以个人为准

定义数据库模型（model）
定义数据验证模型（schema）
定义视图（api）和路由（router）
编写业务（service）
编写数据库操作（crud）

快速开始

本地开发

后端

前端

开发流程

单元测试