docs: update documentation to reflect Phase 2 completion
- Mark Phase 2 (Matches & Ratings API) as completed in all docs - Add new Ratings & Reviews section to README - Update roadmap and progress tracking (72% complete) - Document all Phase 2 features and endpoints in COMPLETED.md - Reorganize TODO.md for Phase 2.5 (WebRTC) as next priority
This commit is contained in:
40
README.md
40
README.md
@@ -29,8 +29,17 @@ Web application (PWA) for the dance community enabling matchmaking, chat, and vi
|
||||
- ✅ **Infinite Scroll** - loading older messages
|
||||
|
||||
**Matchmaking & Private Chat:**
|
||||
- ✅ **Matchmaking** - pairing directly from event chat
|
||||
- ✅ **Private 1:1 Chat** - private chat for matched users with Socket.IO
|
||||
- ✅ **Match Requests** - send and accept match requests with real-time notifications
|
||||
- ✅ **Match Management** - view pending/active matches, accept/reject requests
|
||||
- ✅ **Private 1:1 Chat** - private chat for matched users with Socket.IO and message history
|
||||
- ✅ **Match Slugs** - secure random slugs (CUID) preventing ID enumeration
|
||||
|
||||
**Ratings & Reviews:**
|
||||
- ✅ **Partner Ratings** - rate collaboration partners (1-5 stars, comments)
|
||||
- ✅ **Collaboration Preferences** - "would collaborate again" indicator
|
||||
- ✅ **Public Rating Display** - ratings visible on public user profiles
|
||||
- ✅ **Duplicate Prevention** - users can only rate each match once
|
||||
- ✅ **Auto-completion** - matches auto-complete when both partners have rated
|
||||
|
||||
**Backend & Infrastructure:**
|
||||
- ✅ **PostgreSQL Database** - 7 tables with relations (Prisma ORM)
|
||||
@@ -39,12 +48,11 @@ Web application (PWA) for the dance community enabling matchmaking, chat, and vi
|
||||
- ✅ **Docker Compose** - full orchestration (nginx, frontend, backend, PostgreSQL)
|
||||
- ✅ **Test Coverage** - 81%+ coverage (Jest + Supertest)
|
||||
|
||||
### 🔜 In Progress
|
||||
### 🔜 Next Up
|
||||
|
||||
- ⏳ **Matches API** - create/accept match requests
|
||||
- ⏳ **Ratings API** - rate partner after collaboration (1-5 stars)
|
||||
- ⏳ **WebRTC Signaling** - SDP/ICE exchange via Socket.IO
|
||||
- ⏳ **WebRTC Signaling** - SDP/ICE exchange via Socket.IO for P2P connections
|
||||
- ⏳ **WebRTC P2P Transfer** - real file transfer via RTCDataChannel
|
||||
- ⏳ **Competition Heats** - complete UI integration and real-time updates
|
||||
|
||||
## 🛠️ Tech Stack
|
||||
|
||||
@@ -226,10 +234,11 @@ docker compose --profile dev up --build
|
||||
- id, room_id, user_id, content, type (text/link/video), created_at
|
||||
|
||||
6. **matches** - user pairs
|
||||
- id, user1_id, user2_id, event_id, room_id, status (pending/accepted/completed), created_at
|
||||
- id, slug (unique cuid), user1_id, user2_id, event_id, room_id, status (pending/accepted/completed), created_at
|
||||
|
||||
7. **ratings** - ratings
|
||||
- id, match_id, rater_id, rated_id, score (1-5), comment, would_collaborate_again, created_at
|
||||
- Unique constraint: (match_id, rater_id, rated_id) - prevents duplicate ratings
|
||||
|
||||
### Migrations
|
||||
|
||||
@@ -396,9 +405,16 @@ docker compose exec backend npm run test:coverage
|
||||
- Event participation tracking
|
||||
- Event security (slugs)
|
||||
|
||||
### ⏳ Phase 2: Core Features (IN PROGRESS)
|
||||
- Matches API (create/accept match requests)
|
||||
- Ratings API (rate partner after collaboration)
|
||||
### ✅ Phase 2: Matches & Ratings API (COMPLETED)
|
||||
- Matches API (create/accept match requests with slugs)
|
||||
- Real-time match notifications via Socket.IO
|
||||
- Ratings API (1-5 stars, comments, collaboration preferences)
|
||||
- Public profile ratings display
|
||||
- Profile links from chat and matches pages
|
||||
- Message history for matches
|
||||
- Duplicate rating prevention
|
||||
|
||||
### ⏳ Phase 2.5: WebRTC Implementation (NEXT)
|
||||
- WebRTC signaling (SDP/ICE exchange)
|
||||
- WebRTC P2P file transfer (RTCDataChannel)
|
||||
|
||||
@@ -452,6 +468,6 @@ TBD
|
||||
|
||||
---
|
||||
|
||||
**Current Status:** Phase 1.5 ✅ Completed | Phase 2 ⏳ In Progress (65% overall)
|
||||
**Current Status:** Phase 2 ✅ Completed | Phase 2.5 (WebRTC) ⏳ Next | Progress: ~72% overall
|
||||
|
||||
**Last Updated:** 2025-11-13
|
||||
**Last Updated:** 2025-11-14
|
||||
|
||||
Reference in New Issue
Block a user