radziel/spotlightcam
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update documentation to reflect Phase 2 completion

Browse Source 
- 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:
Radosław Gierwiało
2025-11-14 22:53:54 +01:00
parent c2f4eddb55
commit e9f181052c
3 changed files with 137 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

61
docs/TODO.md
View File

@@ -6,10 +6,10 @@
## 🎯 CURRENT STATUS
**Phase:** 1.6 (Competition Heats System) - ⏳ IN PROGRESS
**Previous Phase:** 1.5 (Email & WSDC & Profiles & Security & QR Check-in) - ✅ COMPLETED
**Next Phase:** 2 (Core Features - Matches API + Ratings + WebRTC) - ⏳ PENDING
**Progress:** ~68% complete
**Phase:** 2.5 (WebRTC Implementation) - ⏳ NEXT
**Previous Phase:** 2 (Matches & Ratings API) - ✅ COMPLETED
**Also Completed:** 1.6 (Competition Heats System - Backend & Frontend) - ✅ COMPLETED
**Progress:** ~72% complete
### ✅ Completed
- Phase 0: Frontend mockup with all views
@@ -27,10 +27,22 @@
- Public profiles (/{username})
- Event participation tracking (auto-save joined events)
- Event security (unique slugs, prevent ID enumeration)
- **QR code event check-in system** (physical presence required at venue)
- QR code event check-in system (physical presence required at venue)
- Phase 1.6: Competition Heats System
- Database schema (divisions, competition_types, event_user_heats)
- Backend API (CRUD operations, validation)
- Frontend components (HeatsBanner, forms, badges)
- Phase 2: Matches & Ratings API
- Match requests with CUID slugs
- Real-time match notifications
- Ratings system (1-5 stars, comments, preferences)
- Public profile ratings display
- Profile links from chat/matches
- Message history persistence
- Duplicate rating prevention
### ⏳ Next Priority
**Core Features** - Matches API + Ratings + WebRTC Signaling
**WebRTC Implementation** - P2P signaling and file transfer
**See:** `docs/COMPLETED.md` for full list of completed tasks
@@ -349,35 +361,12 @@
---
## 📌 NEXT STEPS - Phase 2: Core Features
## 📌 NEXT STEPS - Phase 2.5: WebRTC Implementation
**Estimated Time:** 12-15 hours
**Estimated Time:** 8-10 hours
**Priority:** HIGH
### Step 1: Matches API (3-4h) ⏳
- [ ] Create Match controller and routes
- [ ] `POST /api/matches` - Create match request
- [ ] `POST /api/matches/:id/accept` - Accept match request
- [ ] `GET /api/matches` - List user's matches (active, pending, completed)
- [ ] `GET /api/matches/:id` - Get match details
- [ ] Frontend integration:
- Match request button in EventChatPage
- Match notification handling
- Match acceptance flow
- [ ] Unit tests (match creation, acceptance, validation)
### Step 2: Ratings API (2-3h) ⏳
- [ ] Create Rating controller and routes
- [ ] `POST /api/ratings` - Submit rating after collaboration
- [ ] `GET /api/users/:id/ratings` - Get user's ratings & average
- [ ] `GET /api/matches/:id/rating` - Check if match already rated
- [ ] Frontend integration:
- Update RateMatchPage to use real API
- Display user ratings on profile/active users
- [ ] Validation (1-5 stars, comment length)
- [ ] Unit tests (rating submission, retrieval, validation)
### Step 3: WebRTC Signaling (3-4h) ⏳
### Step 1: WebRTC Signaling (3-4h) ⏳
- [ ] Add Socket.IO signaling events:
- `webrtc_offer` - Send SDP offer
- `webrtc_answer` - Send SDP answer
@@ -389,7 +378,7 @@
- [ ] Connection state monitoring
- [ ] Unit tests (signaling message exchange)
### Step 4: WebRTC File Transfer (4-5h) ⏳
### Step 2: WebRTC File Transfer (4-5h) ⏳
- [ ] RTCDataChannel setup (ordered, reliable)
- [ ] File metadata exchange (name, size, type)
- [ ] File chunking implementation (16KB chunks)
@@ -502,11 +491,13 @@ git commit -m "feat: description"
| Phase 0: Frontend Mockup | ✅ Done | 100% | ~8h (completed) |
| Phase 1: Backend Foundation | ✅ Done | 100% | ~14h (completed) |
| Phase 1.5: Email & WSDC & Profiles | ✅ Done | 100% | ~12h (completed) |
| Phase 2: Core Features | ⏳ Next | 0% | ~15-20h |
| Phase 1.6: Competition Heats | ✅ Done | 100% | ~8h (completed) |
| Phase 2: Matches & Ratings API | ✅ Done | 100% | ~10h (completed) |
| Phase 2.5: WebRTC Implementation | ⏳ Next | 0% | ~8-10h |
| Phase 3: MVP Finalization | ⏳ Pending | 0% | ~15-20h |
| Phase 4: Extensions | ⏳ Pending | 0% | TBD |
**Overall Progress:** ~65% (Phase 0, 1, 1.5 completed)
**Overall Progress:** ~72% (Phases 0, 1, 1.5, 1.6, 2 completed)
---