docs: reorganize documentation structure for better context efficiency

Reorganization changes:
1. Moved from root → docs/:
   - QUICKSTART.md
   - QUICK_TEST.md
   - WEBRTC_TESTING_GUIDE.md

2. Created docs/archive/ and moved archival files:
   - COMPLETED.md (completed tasks archive)
   - PHASE_1.5.md (historical phase documentation)
   - RESOURCES.md (learning resources)
   - SECURITY_AUDIT.md (security audit)
   - ADMIN_CLI.md (CLI documentation)

3. Updated all references in:
   - README.md
   - docs/CONTEXT.md
   - docs/TODO.md
   - docs/SESSION_CONTEXT.md
   - docs/DEPLOYMENT.md
   - docs/QUICK_TEST.md

Active docs/ now contains only essential files:
- SESSION_CONTEXT.md (primary for context restoration)
- TODO.md
- CONTEXT.md
- ARCHITECTURE.md
- DEPLOYMENT.md
- MONITORING.md
- QUICKSTART.md
- QUICK_TEST.md
- WEBRTC_TESTING_GUIDE.md

Benefits:
- Reduced token usage when reading docs/ for context
- Clear separation between active and archived documentation
- Better organization for future maintenance
This commit is contained in:
Radosław Gierwiało
2025-11-20 22:42:06 +01:00
parent 1463b83882
commit 975d258497
13 changed files with 36 additions and 23 deletions

92
docs/QUICKSTART.md Normal file
View File

@@ -0,0 +1,92 @@
# Quick Start - spotlight.cam 🚀
## Uruchomienie (1 minuta!)
```bash
# 1. Uruchom Docker Compose
docker-compose up -d
# 2. Otwórz przeglądarkę
http://localhost:8080
```
## Demo Flow (2 minuty)
### 1. Zaloguj się
- URL: http://localhost:8080/login
- Wpisz **dowolny** email i hasło (np. `test@test.com` / `test123`)
- Mock auth - natychmiast zaloguje
### 2. Wybierz event
- Kliknij na "Warsaw Dance Festival 2025"
- Przycisk "Dołącz do czatu"
### 3. Czat eventowy - Matchmaking
- Zobacz mockowane wiadomości
- Po prawej lista użytkowników
- Kliknij **** przy "sarah_swing"
- Zostaniesz przekierowany do czatu 1:1
### 4. 🔥 Główna funkcjonalność - Wysyłanie filmu WebRTC
- Kliknij **"Wyślij film (WebRTC)"**
- Wybierz dowolny plik wideo z dysku
- Kliknij **"Wyślij film (P2P)"**
- Zobacz:
- ✅ Status WebRTC: disconnected → connecting → connected
- ✅ Progress bar: 0% → 100%
- ✅ Info o szyfrrowaniu E2E (DTLS/SRTP)
- ✅ Wiadomość o przesłanym pliku w czacie
### 5. Fallback - Wysyłanie linku
- Kliknij **"Link"**
- Wklej URL (np. https://drive.google.com/file/d/abc123)
- Kliknij "Wyślij link"
### 6. Oceń partnera
- Kliknij **"Zakończ i oceń"**
- Wybierz 5 gwiazdek ⭐⭐⭐⭐⭐
- Dodaj komentarz: "Świetna współpraca!"
- Zaznacz "Chcę współpracować ponownie"
- Kliknij "Zapisz ocenę"
### 7. Historia
- URL: http://localhost:8080/history
- Zobacz wszystkie matche
- Zobacz otrzymane oceny
- Zobacz statystyki
## Co to jest?
**spotlight.cam** to mockup aplikacji PWA dla społeczności tanecznej. Główna funkcjonalność to **peer-to-peer przesyłanie filmów przez WebRTC**.
### ✅ Zrobione (Mockup)
- Autoryzacja (mock)
- Wybór eventów
- Czat eventowy (matchmaking)
- Czat 1:1
- **🔥 Mockup WebRTC P2P transfer** (symulacja transferu plików)
- System ocen
- Historia współprac
### 🔜 Do zrobienia
- Backend (Node.js + Express + PostgreSQL)
- WebSocket (Socket.IO) - real-time
- **Prawdziwy WebRTC P2P** (RTCDataChannel, chunking, progress monitoring)
- JWT autoryzacja
- Deployment
## Zatrzymanie
```bash
docker-compose down
```
## Pomoc
- Pełna dokumentacja: `README.md`
- Architektura: `docs/CONTEXT.md`
- Roadmap: `docs/TODO.md`
---
**Mockup jest w pełni funkcjonalny!** WebRTC transfer jest symulowany, prawdziwa implementacja będzie w kolejnym etapie.