Skip to content

Todo プロジェクトドキュメント

このサイトでは Todo アプリケーションの主要なコンセプトや開発方法をまとめています。軽量な Flask API と Next.js フロントエンドを組み合わせ、ローカルで完結するシンプルなフルスタック構成を実現しています。

リポジトリ構成

  • backend/: Todo アイテム向け CRUD エンドポイントを提供する Flask サービスと、pytest ベースの API テスト。
  • frontend/: バックエンド API を利用して UI を描画する Next.js 14(App Router)プロジェクト。
  • docs/: 本ページを含む MkDocs 用ドキュメントソース。ビルドすると site/ に静的サイトが生成されます。
  • .github/: GitHub Actions による CI/CD ワークフロー定義。

詳細なフォルダ構成と各ディレクトリの役割については プロジェクト構成 を参照してください。

次に読むもの

  • フォルダ構成とディレクトリの詳細は プロジェクト構成 をご覧ください。
  • 実行時構成やデータフローについて詳しくは アーキテクチャ を参照してください。
  • 利用している言語・フレームワーク・ツールチェーンの全体像は 技術スタック にまとめています。
  • コーディング規約については コーディングガイドライン を確認してください。
  • 実装詳細を確認したい場合は、バックエンド・フロントエンドの各ソースコードやテストを読み進めてください。