FastAPI 全栈模板

技术栈和特性

⚡ FastAPI 用于 Python 后端 API。
- 🧰 SQLModel 用于 Python SQL 数据库交互（ORM）。
- 🔍 Pydantic，由 FastAPI 使用，用于数据验证和设置管理。
- 💾 PostgreSQL 作为 SQL 数据库。
🚀 React 用于前端。
- 💃 使用 TypeScript、钩子、Vite 和其他现代前端技术栈组件。
- 🎨 Chakra UI 用于前端组件。
- 🤖 自动生成的前端客户端。
- 🧪 Playwright 用于端到端测试。
- 🦇 支持暗黑模式。
🐋 Docker Compose 用于开发和生产。
🔒 默认安全的密码哈希。
🔑 JWT（JSON Web Token）身份验证。
📫 基于邮件的密码恢复。
✅ 使用 Pytest 进行测试。
📞 Traefik 作为反向代理/负载均衡器。
🚢 使用 Docker Compose 的部署说明，包括如何设置前端 Traefik 代理以处理自动 HTTPS 证书。
🏭 基于 GitHub Actions 的 CI（持续集成）和 CD（持续部署）。

仪表板登录

仪表板 - 管理员

仪表板 - 创建用户

仪表板 - 项目

仪表板 - 用户设置

仪表板 - 暗黑模式

交互式 API 文档

如何使用

你可以直接 fork 或克隆这个仓库并按原样使用。

✨ 它可以直接使用。✨

如何使用私有仓库

如果你想拥有一个私有仓库，GitHub 不允许你简单地 fork 它，因为它不允许更改 fork 的可见性。

但你可以执行以下操作：

创建一个新的 GitHub 仓库，例如 my-full-stack。
手动克隆这个仓库，设置名称为你想使用的项目名称，例如 my-full-stack：

git clone git@github.com:fastapi/full-stack-fastapi-template.git my-full-stack

cd my-full-stack

将新的 origin 设置为你的新仓库，从 GitHub 界面复制它，例如：

git remote set-url origin git@github.com:octocat/my-full-stack.git

将此仓库添加为另一个"远程"，以便日后获取更新：

git remote add upstream git@github.com:fastapi/full-stack-fastapi-template.git

将代码推送到你的新仓库：

git push -u origin master

从原始模板更新

克隆仓库并进行修改后，您可能想获取原始模板的最新更改。

确保您已将原始仓库添加为远程仓库，可以通过以下命令检查：

git remote -v

origin    git@github.com:octocat/my-full-stack.git (fetch)
origin    git@github.com:octocat/my-full-stack.git (push)
upstream    git@github.com:fastapi/full-stack-fastapi-template.git (fetch)
upstream    git@github.com:fastapi/full-stack-fastapi-template.git (push)

拉取最新更改但不合并：

git pull --no-commit upstream master

这将下载此模板的最新更改但不提交，这样您可以在提交前检查一切是否正确。

如果有冲突，在编辑器中解决它们。
完成后，提交更改：

git merge --continue

配置

然后您可以更新 .env 文件中的配置以自定义您的设置。

在部署之前，请确保至少更改以下值：

SECRET_KEY
FIRST_SUPERUSER_PASSWORD
POSTGRES_PASSWORD

您可以（也应该）从密钥中以环境变量的形式传递这些值。

查阅 deployment.md 文档了解更多细节。

生成密钥

.env 文件中的一些环境变量默认值为 changethis。

您必须将它们更改为密钥，要生成密钥，可以运行以下命令：

python -c "import secrets; print(secrets.token_urlsafe(32))"

复制内容并将其用作密码/密钥。再次运行该命令以生成另一个安全密钥。

如何使用 - 使用 Copier 的替代方法

本仓库还支持使用 Copier 生成新项目。

它会复制所有文件，询问您配置问题，并用您的答案更新 .env 文件。

安装 Copier

您可以通过以下方式安装 Copier：

pip install copier

或者更好的是，如果您有 pipx，可以运行：

pipx install copier

注意：如果您有 pipx，安装 copier 是可选的，您可以直接运行它。

使用 Copier 生成项目

为您的新项目目录决定一个名称，您将在下面使用它。例如，my-awesome-project。

转到将作为项目父目录的目录，并使用您的项目名称运行以下命令：

copier copy https://github.com/fastapi/full-stack-fastapi-template my-awesome-project --trust

如果您有 pipx 但没有安装 copier，可以直接运行：

pipx run copier copy https://github.com/fastapi/full-stack-fastapi-template my-awesome-project --trust

注意 --trust 选项是必要的，以便能够执行一个创建后脚本来更新您的 .env 文件。

输入变量

Copier 会询问您一些数据，在生成项目之前您可能想准备好这些信息。

但不用担心，之后您可以在 .env 文件中更新任何内容。

输入变量及其默认值（一些自动生成）如下：

project_name：（默认："FastAPI Project"）项目名称，显示给 API 用户（在 .env 中）。
stack_name：（默认："fastapi-project"）用于 Docker Compose 标签和项目名称的堆栈名称（无空格，无句点）（在 .env 中）。
secret_key：（默认："changethis"）项目的密钥，用于安全，存储在 .env 中，您可以使用上述方法生成一个。
first_superuser：（默认："admin@example.com"）第一个超级用户的邮箱（在 .env 中）。
first_superuser_password：（默认："changethis"）第一个超级用户的密码（在 .env 中）。
smtp_host：（默认：""）用于发送邮件的 SMTP 服务器主机，您可以稍后在 .env 中设置。
smtp_user：（默认：""）用于发送邮件的 SMTP 服务器用户，您可以稍后在 .env 中设置。
smtp_password：（默认：""）用于发送邮件的 SMTP 服务器密码，您可以稍后在 .env 中设置。
emails_from_email：（默认："info@example.com"）用于发送邮件的邮箱账户，您可以稍后在 .env 中设置。
postgres_password：（默认："changethis"）PostgreSQL 数据库的密码，存储在 .env 中，您可以使用上述方法生成一个。
sentry_dsn：（默认：""）Sentry 的 DSN，如果您使用它，可以稍后在 .env 中设置。