README.md

ドキュメント概要

このディレクトリには、バックエンドとフロントエンドの技術仕様や API 定義、将来的な改善方針など、開発に関わるドキュメントをまとめています。

目次

• ドキュメント概要
  • 目次
  • 1. API ドキュメント
  • 2. 認証の仕様
  • 3. データベース設計
  • 4. エラーハンドリング方針
  • 5. 将来的な改善アイデア
  • 6. Git 管理
  • 7. パッケージ管理

---

1. API ドキュメント

各エンドポイントごとの仕様は以下にまとめています。

• server : /api/v1/
• client : /
• 詳細はこちら

---

2. 認証の仕様

• auth.md: JWT を用いたログイン・登録・トークンリフレッシュなどの仕様。

---

3. データベース設計

• db-schema.md: MongoDB のコレクション構成とスキーマの詳細。

---

4. エラーハンドリング方針

• error-handling.md: クライアント・サーバー間での統一的なエラー設計について。

---

5. 将来的な改善アイデア

• future.md: 今後追加したい機能や改善案のメモ。

---

6. Git 管理

• git-management.md: Git 管理用のブランチ・コミットルールについて。

---

7. パッケージ管理

• packages.md: インストールするパッケージについて。