クイック FastAPI

日本語 | English

このリポジトリは、FastAPI プロジェクトを素早くセットアップするためのシェルスクリプトを提供しています。 とにかくちゃちゃっと試したい人は是非。

スクリプト:

• quickFastAPI.sh — 基本的な FastAPI プロジェクトをチャチャっとセットアップします。
• setupDocker.sh — Docker 用のイメージ作成から、起動までを行います。

---

前提条件

システムに以下がインストールされていることを確認してください:

• Python 3.12
• uv pip (インストールはこちら)

Docker上で起動するには:

• Dcoker (インストールはこちら)

---

使い方

1. このリポジトリをクローンするか、シェルスクリプトをダウンロードする

git clone https://github.com/testkun08080/FastAPI-QuickSetup.git
cd FastAPI-QuickSetup

または以下スクリプトを直接ダウンロードしてください:

Note

ファイルをダウンロードするには、リンクを右クリックして「名前を付けてリンク先を保存」などのオプションを選択してください。

quickFastAPI.sh をダウンロード
setupDocker.sh をダウンロード

2. シェルスクリプトを実行

1. スクリプトを実行して、ローカル環境に FastAPI プロジェクトをセットアップします:

   ./quickFastAPI.sh

2. ターミナルでプロジェクト名を入力するように求められます:

   Setting up a FastAPI project...
   Enter the project name: <PROJECT_NAME>

3. FastAPI サーバーをすぐに起動するかどうか尋ねられます:

   Would you like to start the FastAPI server now? (y/n): 

4. 後で手動でサーバーを起動するには、以下のコマンドを使用します:

   cd <PROJECT_NAME>
   ./run.sh

5. アプリケーションがローカルで起動したら、以下の URL をブラウザで開いてアクセスします: http://127.0.0.1:8000/

3. Docker でアプリケーションをビルド・実行

1. Docker セットアップスクリプトに実行権限を付与し、実行:

   chmod +x setupDocker.sh
   ./setupDocker.sh

2. プロンプトが表示されたら、Docker ビルドに使用するディレクトリを番号で選択:

   Select a directory from the list below:
   1) <PROJECT_NAME>/

3. セットアップが正常に完了すると、次のようなメッセージが表示されます:

   Docker setup complete!
   Your FastAPI application is now running at: http://localhost:8000

   http://localhost:8000

---

ライセンス

このプロジェクトは MIT ライセンスの下で提供されています。
詳細は LICENSE ファイルをご覧ください。