Files
spotlightcam/QUICKSTART.md
Radosław Gierwiało 80ff4a70bf feat: initial project setup with frontend mockup
- Docker Compose setup with nginx reverse proxy and frontend service
- React + Vite + Tailwind CSS configuration
- Complete mockup of all application views:
  - Authentication (login/register)
  - Events list and selection
  - Event chat with matchmaking
  - 1:1 private chat with WebRTC P2P video transfer mockup
  - Partner rating system
  - Collaboration history
- Mock data for users, events, messages, matches, and ratings
- All UI text and messages in English
- Project documentation (CONTEXT.md, TODO.md, README.md, QUICKSTART.md)
2025-11-12 17:50:44 +01:00

93 lines
2.3 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 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.