WebAppTemplate / flask-app /
..
backend first commit 5 months ago
README.md first commit 5 months ago
docker-compose.yml first commit 5 months ago
README.md

Flask Web Application

シンプルなFlask Webアプリケーションのテンプレートです。Docker Composeで簡単に起動できます。

🚀 プロジェクト構成

flask-app/
├── docker-compose.yml      # Docker Compose設定
├── README.md              # このファイル
└── backend/
    ├── app.py             # Flaskアプリケーション本体
    ├── Dockerfile         # Dockerイメージ定義
    ├── requirements.txt   # Python依存パッケージ
    ├── static/           # 静的ファイル(CSS, JS)
    │   ├── app.js
    │   └── style.css
    └── templates/        # HTMLテンプレート
        └── index.html

🏃 起動方法

1. アプリケーションの起動

/flask-app ディレクトリに移動して、以下のコマンドを実行:

docker compose up -d

2. アクセス

ブラウザで以下のURLにアクセス:

http://localhost:5000

3. 停止

docker compose down

🔌 API エンドポイント

GET /

  • トップページ(index.html)を表示

GET /api/health

  • 応答確認API
  • レスポンス例:
    {
      "ok": true,
      "message": "hello from Flask"
    }
    

POST /api/echo

  • 送信されたJSONをそのまま返すエコーAPI
  • リクエスト例:
    {
      "name": "test",
      "time": "2026-02-08T12:50:16.020Z"
    }
    
  • レスポンス例:
    {
      "ok": true,
      "you_sent": {
        "name": "test",
        "time": "2026-02-08T12:50:16.020Z"
      }
    }
    

🛠️ 開発

ログの確認

docker compose logs -f

コンテナ内に入る

docker compose exec backend /bin/sh

ソースコードの編集

ホストマシンの backend/ ディレクトリ内のファイルを編集すると、コンテナ内のアプリケーションに即座に反映されます。(デバッグモードのため)

📦 使用技術

  • Flask - PythonのWebフレームワーク

📝 備考

  • デバッグモードが有効になっているため、本番環境では設定を変更してください
  • ポート5000を使用しています。他のアプリケーションと競合する場合はdocker-compose.ymlのポート設定を変更してください