プロジェクトの準備

このページで扱う手順で、Git がインストールされていることを確認します。

1. サンプルリポジトリのクローン

以下のコマンドで、Git がインストールされていることを確認します。

git --version

以下のように Git のバージョンが表示されれば、インストールは確認できています。

git version 2.x.x

バージョンが表示されない場合は、Git/GitHubのセットアップ を先に実施してください。

インストールが確認できたら、この章で使用するノートアプリケーションのソースコードをGitHubのサンプルリポジトリからクローンします。コマンドプロンプト(Windows)またはターミナル(Mac)を開き、任意の場所で以下のコマンドを実行します。

git clone https://github.com/gevanni-academy/sample-note-api.git

クローンが完了したら、Visual Studio Codeを起動し、「ファイル」→「フォルダーを開く」から、クローンしたsample-note-apiフォルダを開いてください。以降の操作は、Visual Studio Codeのターミナルから行います。

2. フォルダ構成の確認

クローンしたリポジトリのフォルダ構成は以下のようになっています。

sample-note-api
├── compose.yaml
├── api/
│   ├── Dockerfile
│   ├── main.py
│   ├── models.py
│   ├── database.py
│   ├── requirements.txt
│   └── routers/
│       └── notes.py
├── front/
│   ├── Dockerfile
│   ├── index.html
│   ├── style.css
│   └── script.js
└── db/
    └── init.sql

各フォルダは3層アーキテクチャの各層に対応しています。

フォルダ 層 内容
db/ データベース層 init.sql(テーブル作成・テストデータ投入用の初期化SQL)
api/ アプリケーション層 FastAPIのソースコード、Dockerfile、requirements.txt
front/ プレゼンテーション層 HTML/CSS/JavaScriptのフロントエンド、Nginx用のDockerfile

そして、プロジェクトのルートにcompose.yamlがあります。このファイルがDocker Composeの設定ファイルで、3つのサービスの構成をまとめて定義しています。

💡 ポイント
PythonやFastAPIの詳しい説明は省略します。コードの詳細については PythonでREST APIを作ろう に記載があります。この章では、Docker Composeの設定と使い方に集中します。