full stack fastapi template

フルスタック FastAPI テンプレート

技術スタックと機能

• ⚡ Python バックエンド API 用のFastAPI 。
  • ? Python SQL データベース インタラクション (ORM) の SQLModel。
  • ?データ検証と設定管理のために FastAPI によって使用される Pydantic。
  • ? SQL データベースとしての PostgreSQL。
• フロントエンドに反応します。
  • ? TypeScript、フック、Vite、および最新のフロントエンド スタックのその他の部分を使用します。
  • ?フロントエンドコンポーネントのChakra UI。
  • ?自動生成されたフロントエンド クライアント。
  • ?エンドツーエンドテストの劇作家。
  • ?ダークモードのサポート。
• ?開発および実稼働用の Docker Compose。
• デフォルトで安全なパスワードハッシュ。
• ? JWT (JSON Web トークン) 認証。
• ?電子メールベースのパスワード回復。
• ✅ Pytest によるテスト。
• ?リバース プロキシ/ロード バランサーとしての Traefik。
• ? Docker Compose を使用したデプロイ手順 (自動 HTTPS 証明書を処理するようにフロントエンド Traefik プロキシをセットアップする方法を含む)。
• ? 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

• 新しいオリジンを新しいリポジトリに設定し、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ファイルが更新されます。

コピー機の設置

Copier は次の方法でインストールできます。

pip install copier

あるいは、 pipxがある場合は、次のように実行できます。

pipx install copier

注: pipxがある場合、コピー機のインストールはオプションであり、直接実行できます。

コピー機でプロジェクトを生成する

新しいプロジェクトのディレクトリの名前を決定します。これは以下で使用します。たとえば、 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

.envファイルを更新する作成後スクリプトを実行できるようにするには、 --trustオプションが必要であることに注意してください。

入力変数

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 ライセンスの条件に基づいてライセンスされています。