full stack fastapi template

全栈 FastAPI 模板

技术栈及特点

• ⚡ 用于 Python 后端 API 的FastAPI 。
  • ？用于 Python SQL 数据库交互 (ORM) 的 SQLModel。
  • ？ Pydantic，由 FastAPI 使用，用于数据验证和设置管理。
  • ？ PostgreSQL 作为 SQL 数据库。
• 为前端做出反应。
  • ？使用 TypeScript、hooks、Vite 和现代前端堆栈的其他部分。
  • ？前端组件的 Chakra UI。
  • ？自动生成的前端客户端。
  • ？端到端测试的剧作家。
  • ？深色模式支持。
• ？ Docker Compose 用于开发和生产。
• 默认情况下安全密码散列。
• ？ JWT（JSON Web 令牌）身份验证。
• ？基于电子邮件的密码恢复。
• ✅ 使用 Pytest 进行测试。
• ？ Traefik 作为反向代理/负载均衡器。
• ？使用 Docker Compose 的部署说明，包括如何设置前端 Traefik 代理来处理自动 HTTPS 证书。
• ？基于GitHub Actions的CI（持续集成）和CD（持续部署）。

仪表板登录

仪表板 - 管理员

仪表板 - 创建用户

仪表板 - 项目

仪表板 - 用户设置

仪表板 - 深色模式

交互式API文档

如何使用

您可以直接分叉或克隆此存储库并按原样使用它。

它就是有效的。

如何使用私有存储库

如果您想拥有一个私有存储库，GitHub 不会允许您简单地分叉它，因为它不允许更改分叉的可见性。

但您可以执行以下操作：

• 创建一个新的 GitHub 存储库，例如my-full-stack 。
• 手动克隆此存储库，将名称设置为您要使用的项目的名称，例如my-full-stack ：

git clone [email protected]:fastapi/full-stack-fastapi-template.git my-full-stack

• 进入新目录：

 cd my-full-stack

• 将新的origin设置为您的新存储库，从GitHub界面复制它，例如：

git remote set-url origin [email protected]:octocat/my-full-stack.git

• 将此存储库添加为另一个“远程”，以便您稍后获取更新：

git remote add upstream [email protected]:fastapi/full-stack-fastapi-template.git

• 将代码推送到您的新存储库：

git push -u origin master

从原始模板更新

克隆存储库并进行更改后，您可能希望从此原始模板获取最新更改。

• 确保您将原始存储库添加为远程存储库，您可以使用以下命令进行检查：

git remote -v

origin    [email protected]:octocat/my-full-stack.git (fetch)
origin    [email protected]:octocat/my-full-stack.git (push)
upstream    [email protected]:fastapi/full-stack-fastapi-template.git (fetch)
upstream    [email protected]: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 生成新项目。

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

安装复印机

您可以通过以下方式安装复印机：

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 ：（默认值： "[email protected]" ）第一个超级用户的电子邮件（在 .env 中）。
• first_superuser_password ：（默认值： "changethis" ）第一个超级用户的密码（在 .env 中）。
• smtp_host ：（默认值：“”）发送电子邮件的 SMTP 服务器主机，您可以稍后在 .env 中设置它。
• smtp_user ：（默认：“”）发送电子邮件的 SMTP 服务器用户，您可以稍后在 .env 中设置。
• smtp_password ：（默认值：“”）发送电子邮件的 SMTP 服务器密码，您可以稍后在 .env 中设置。
• emails_from_email ：（默认值： "[email protected]" ）发送电子邮件的电子邮件帐户，您可以稍后在 .env 中设置。
• postgres_password : (默认: "changethis" ) PostgreSQL 数据库的密码，存储在 .env 中，你可以用上面的方法生成一个。
• sentry_dsn : (默认值: "") Sentry 的 DSN，如果你正在使用它，你可以稍后在 .env 中设置它。

后端开发

后端文档：backend/README.md。

前端开发

前端文档：frontend/README.md。

部署

部署文档：deployment.md。

发展

一般开发文档：development.md。

这包括使用 Docker Compose、自定义本地域、 .env配置等。

发行说明

检查文件release-notes.md。

执照

全栈 FastAPI 模板根据 MIT 许可证条款获得许可。