Files
spotlightcam/docs/archive/QUICKSTART.md
Radosław Gierwiało 913d685721 docs: streamline README and update SESSION_CONTEXT, archive outdated docs
- Streamline README.md from 645 to 365 lines (43% reduction)
- Remove duplicate content with other documentation files
- Focus README on quick start, features overview, and links to detailed docs
- Update SESSION_CONTEXT.md with recent changes (342/342 tests, matching runs audit)
- Archive outdated documentation:
  - CONTEXT.md (duplicated in README)
  - QUICKSTART.md (mentions mock auth, outdated)
  - QUICK_TEST.md (outdated)
- Keep SESSION_CONTEXT.md active for context restoration
2025-11-30 20:17:27 +01:00

2.3 KiB
Raw Permalink Blame History

Quick Start - spotlight.cam 🚀

Uruchomienie (1 minuta!)

# 1. Uruchom Docker Compose
docker-compose up -d

# 2. Otwórz przeglądarkę
http://localhost:8080

Demo Flow (2 minuty)

1. Zaloguj się

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

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

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

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.