README 最終要件

[rt6500]

概要

課題PDFの README Requirements に沿って、最終評価用の README.md を完成させる。

README は評価者がプロジェクトの構成、選択モジュール、ポイント計算、実装内容、チームメンバーの貢献を確認するための重要な資料になるため、評価前に必ず整備する。

---

背景

課題PDFでは、README に以下の内容を含めることが求められている。

• プロジェクト概要
• 使用技術・フレームワーク
• セットアップ・起動方法
• 選択モジュール一覧
• ポイント計算
• 各モジュールの実装説明
• DB schema または構成説明
• チームメンバーのロール・貢献
• AI 使用箇所
• Privacy Policy / Terms of Service への参照

現状の README は開発セットアップ中心のため、最終評価に必要な説明を追加する必要がある。

---

やること

• README を英語で整備する
• プロジェクト概要を追加する
• 技術スタックを明記する
  • Frontend
  • Backend
  • Database
  • Realtime communication
  • Infrastructure
• 起動方法を最新状態に合わせて整理する
  • one command startup
  • migration
  • access URL
  • HTTPS / self-signed certificate の注意
• 選択モジュール一覧を追加する
• ポイント計算を明記する
• 各モジュールについて、どのように実装したかを説明する
• DB schema / relations の概要を記載する
• チームメンバーごとのロール・貢献を記載する
• AI 使用箇所を記載する
• Privacy Policy / Terms of Service ページへの参照を追加する
• 評価者が確認すべき主要導線を記載する

---

README に含めたい項目案

Project Overview

• ft_transcendence project
• Web-based Bomberman-style multiplayer game
• Authentication, profile, friends, room lobby, real-time gameplay, match history

Tech Stack

• React
• TypeScript
• Zustand
• NestJS
• Prisma
• PostgreSQL
• Socket.io
• Docker / Docker Compose
• nginx
• HTTPS with self-signed certificate

How to Run

• .env setup
• make
• migration command
• frontend URL
• backend API URL
• self-signed certificate warning

Selected Modules and Points

例:

Category	Module	Type	Points
Web	Use framework for frontend and backend	Major	2
Web	Real-time features using WebSockets	Major	2
Web	User interaction	Major	2
Gaming	Web-based game	Major	2
Gaming	Remote players	Major	2
Gaming	Multiplayer game	Major	2
User Management	Standard user management	Major	2
User Management	Game statistics and match history	Minor	1
Total			15

Module Implementation Details

• Framework
• WebSocket / real-time
• User interaction
• Web-based game
• Remote players
• Standard user management
• Notification system
• Game statistics and match history

Database Schema

• User
• Friendship
• GameRoom
• RoomParticipant
• RoomMessage
• Match
• MatchParticipant
• UploadedImage
• relations overview

Team Contributions

• member name
• role
• main features
• relevant modules

AI Usage

• where AI was used
• for what purpose
• how output was reviewed or modified

Legal Pages

• Privacy Policy link
• Terms of Service link

---

やらないこと

• 詳細すぎる内部実装説明
• 全API仕様の完全な掲載
• 開発中の古い仕様の記載
• 未実装機能を実装済みのように書くこと
• 日本語READMEへの変更

---

完了条件

• README が英語で書かれている
• 起動方法が最新の実装と一致している
• 選択モジュールとポイント計算が明記されている
• 各モジュールの実装内容が説明されている
• DB schema / relations の概要が記載されている
• チームメンバーの貢献が記載されている
• AI 使用箇所が記載されている
• Privacy Policy / Terms of Service への参照がある
• README の内容が実装状態と矛盾していない

---

優先度

P1

理由:

• 課題PDFの README Requirements に含まれる
• 評価者がモジュール内容とポイント計算を確認するために必要
• ただし実装内容が確定してから最終更新する必要があるため、まず骨子を作り、評価前に最終反映するのがよい