full stack fastapi template

Python

0.7.1

下載

全端 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文件

儀表板 - 管理者

API文件

儀表板 - 建立用戶

API文件

儀表板 - 項目

API文件

儀表板 - 使用者設定

API文件

儀表板 - 深色模式

API文件

互動式API文檔

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 中設定它。