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

docs: update README with current features and test count

Browse Source 
- Add Dashboard, Recording Matching, Competitor Numbers to features
- Update test count: 223 → 286 (73% coverage)
- Mark security features as implemented (CSRF, account lockout)
- Update Phase 3 section with actual completed items
- Update last modified date
This commit is contained in:
Radosław Gierwiało
2025-11-23 23:12:00 +01:00
parent 0d083dcb22
commit 61d23681ff
1 changed files with 29 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
README.md
View File

@@ -63,14 +63,21 @@ Web application (PWA) for the dance community enabling matchmaking, chat, and vi
- ✅ **Test Coverage** - comprehensive test suite for WebRTC, Auth, Events, Matches - ✅ **Test Coverage** - comprehensive test suite for WebRTC, Auth, Events, Matches
- ✅ **WebRTC Tests** - full Socket.IO signaling and detection tests (7 tests passing) - ✅ **WebRTC Tests** - full Socket.IO signaling and detection tests (7 tests passing)
### 🔜 Next Up **Dashboard & Real-time:**
- ✅ **Dashboard** - centralized landing page with active events, matches, requests
- ✅ **Online Count** - real-time users in event chat
- ✅ **Unread Count** - unread message badges per match
- ✅ **Recording Matching** - auto-assign recorders for competition heats
- ✅ **Competitor Numbers** - bib number support for events
**MVP is complete!** Ready for production deployment. Future extensions: **Security & PWA (All Implemented):**
- ⏳ **Security Hardening** - CORS, CSRF, Helmet.js, CSP - ✅ **Security Hardening** - CORS, CSRF, Helmet.js, account lockout, rate limiting
- ⏳ **PWA Features** - manifest, service worker, offline support - ✅ **PWA Features** - manifest, service worker, offline support, iOS compatible
- ⏳ **Competition Heats UI** - complete UI integration and real-time updates
### 🔜 Future Extensions
- ⏳ **User Badges** - trust system and reputation badges - ⏳ **User Badges** - trust system and reputation badges
- ⏳ **Push Notifications** - real-time alerts for matches and messages - ⏳ **Push Notifications** - real-time alerts for matches and messages
- ⏳ **Video Compression** - client-side compression before transfer
## 🛠️ Tech Stack ## 🛠️ Tech Stack
@@ -93,7 +100,7 @@ Web application (PWA) for the dance community enabling matchmaking, chat, and vi
- **bcrypt** - password hashing - **bcrypt** - password hashing
- **JWT** - token-based authentication - **JWT** - token-based authentication
- **AWS SES** - email service - **AWS SES** - email service
- **Jest + Supertest** - testing (81%+ coverage) - **Jest + Supertest** - testing (286 tests, 73% coverage)
### Infrastructure ### Infrastructure
- **Docker Compose** - container orchestration (dev + prod profiles) - **Docker Compose** - container orchestration (dev + prod profiles)
@@ -450,21 +457,23 @@ REPL specifics:
- Room-based access control - Room-based access control
- User verification before joining rooms - User verification before joining rooms
### Planned Security Features (Phase 3): ### Additional Security (Phase 3 - Implemented):
⏳ CORS configuration ✅ CORS configuration
⏳ CSRF protection (cookies) ✅ CSRF protection (cookies)
⏳ Helmet.js security headers ✅ Helmet.js security headers
⏳ Content Security Policy ✅ Account lockout (after failed attempts)
⏳ HTTPS enforcement (production) ✅ Content Security Policy
⏳ HTTPS enforcement (requires production SSL setup)
## 📊 Test Coverage ## 📊 Test Coverage
**Backend: 71.31% overall coverage** (223/223 tests passing - 100%) **Backend: 73% overall coverage** (286/286 tests passing - 100%)
- **WebRTC Signaling**: 7/7 tests passing (offer/answer/ICE relay, authorization) - **WebRTC Signaling**: 7/7 tests passing (offer/answer/ICE relay, authorization)
- **Auth Controllers**: Comprehensive coverage - **Auth Controllers**: Comprehensive coverage
- **Events API**: Full test suite - **Events API**: Full test suite
- **Matches API**: Full CRUD tests - **Matches API**: Full CRUD tests
- **Dashboard API**: 12 tests passing
- **Socket.IO**: Full WebRTC + chat coverage - **Socket.IO**: Full WebRTC + chat coverage
- **Test Isolation**: Fixed with unique test data per suite (100% passing) - **Test Isolation**: Fixed with unique test data per suite (100% passing)
@@ -527,11 +536,12 @@ docker compose exec backend npm run test:coverage
### ✅ Phase 3: MVP Finalization (COMPLETED) ### ✅ Phase 3: MVP Finalization (COMPLETED)
- ✅ Landing page - ✅ Landing page
- ✅ WebRTC tests (7/7 passing) - ✅ Dashboard with online/unread counts
- ✅ All backend tests passing (223/223 - 100%) - ✅ Recording matching system (auto-assign recorders)
- ✅ Test isolation fixes (unique test data per suite) - ✅ Security hardening (CSRF, account lockout, rate limiting)
- ✅ PWA features (manifest, service worker, iOS support)
- ✅ All backend tests passing (286/286 - 100%)
- ✅ Production operations scripts (backup, restore, health check) - ✅ Production operations scripts (backup, restore, health check)
- ✅ Monitoring & logging documentation
- ✅ Documentation cleanup and reorganization - ✅ Documentation cleanup and reorganization
### ⏳ Phase 4: Extensions (FUTURE) ### ⏳ Phase 4: Extensions (FUTURE)
@@ -584,6 +594,6 @@ TBD
--- ---
**Current Status:** Phase 3 (MVP Finalization) ✅ COMPLETED | 100% MVP Complete | Ready for Production Deployment **Current Status:** MVP Complete ✅ | 286 tests passing | Ready for Production Deployment
**Last Updated:** 2025-11-20 **Last Updated:** 2025-11-23