Update README.md

README.md

@@ -1,194 +1,11 @@
-# P2P Signal Server
-
-Real-time WebRTC signaling server for 10,000 concurrent users.  
-Runs on **Hugging Face Spaces Free Tier** (Docker, port 7860).
-
----
-
-## Architecture
-
-```
-Client A ──WS──► HF Space (Signal Server)
-                     │
-                     ├─ Redis Bucket 1 (Presence)   uid→socketId, online/offline
-                     ├─ Redis Bucket 2 (Msg Queue)  offline_msgs:{uid} list
-                     ├─ MongoDB Atlas               user profiles, friend lists
-                     └─ Supabase Storage            media files (server sees 0 bytes)
-
-Client A ◄──────────────────────────────► Client B   (WebRTC P2P after handshake)
-         ◄── WS relay fallback if ICE fails ─────────►
-```
-
----
-
-## Quick Start
-
-### 1. Clone & install
-
-```bash
-git clone https://github.com/you/p2p-signal-server
-cd p2p-signal-server
-npm install
-cp .env.example .env
-# Fill in all values in .env
-npm run dev
-```
-
-### 2. Build & run (Docker)
-
-```bash
-docker build -t p2p-signal .
-docker run --env-file .env -p 7860:7860 p2p-signal
-```
-
 ---
-
-## Required Secrets
-
-Add all of these to **HF Spaces → Settings → Repository Secrets**.
-
-| Variable | How to get it |
-|---|---|
-| `JWT_SECRET` | `node -e "console.log(require('crypto').randomBytes(64).toString('hex'))"` |
-| `REDIS_PRESENCE_URL` | [Upstash](https://upstash.com) → Create Redis DB #1 → Copy Redis URL |
-| `REDIS_MESSAGE_URL` | Upstash → Create Redis DB **#2** (separate!) → Copy Redis URL |
-| `MONGO_URI` | [MongoDB Atlas](https://cloud.mongodb.com) → M0 Free → Connect → Driver URL |
-| `SUPABASE_URL` | [Supabase](https://supabase.com) → Project Settings → API → Project URL |
-| `SUPABASE_SERVICE_KEY` | Supabase → Project Settings → API → `service_role` key |
-| `SUPABASE_BUCKET` | Create a bucket named `media` in Supabase Storage, set to **public** |
-| `TURN_URL` | [metered.ca/tools/openrelay](https://www.metered.ca/tools/openrelay/) free TURN |
-| `TURN_USERNAME` | From the same TURN provider |
-| `TURN_CREDENTIAL` | From the same TURN provider |
-| `ALLOWED_ORIGINS` | Your frontend domain(s), comma-separated e.g. `https://myapp.vercel.app` |
-
-Optional (have defaults):
-
-| Variable | Default | Notes |
-|---|---|---|
-| `PORT` | `7860` | Must stay 7860 for HF Spaces |
-| `STUN_SERVERS` | Google STUN | Comma-separated stun: URIs |
-| `PRESENCE_TTL_S` | `60` | Redis TTL for online status |
-| `OFFLINE_MSG_TTL_S` | `604800` | 7 days — how long to hold queued msgs |
-| `HEARTBEAT_INTERVAL_MS` | `30000` | Client sends ping every 30s |
-| `MAX_FILE_SIZE_MB` | `99` | Max single file size |
-| `MAX_FILE_COUNT` | `10` | Max files per upload request |
-
+title: Chatapi
+emoji: 🏆
+colorFrom: red
+colorTo: purple
+sdk: docker
+pinned: false
+short_description: A simple chatting api
 ---
 
-## HF Spaces Deploy
-
-1. Create a new Space → **Docker** SDK
-2. Push this repo to the Space's git remote
-3. Add all secrets in Space settings
-4. The Space will auto-build via the Dockerfile
-
-Health check: `GET /health` → `{ status: 'ok', connections: N, ts: epoch }`
-
----
-
-## WebSocket Protocol
-
-Connect: `wss://your-space.hf.space?token=<JWT>`
-
-### Client → Server
-
-```jsonc
-// Heartbeat (every 30s)
-{ "type": "heartbeat", "payload": {} }
-
-// Send a text message
-{ "type": "message", "payload": { "toUid": "bob", "type": "text", "content": "Hello" } }
-
-// Send a media message (after uploading to Supabase)
-{ "type": "message", "payload": { "toUid": "bob", "type": "media", "content": "https://...", "mediaType": "image/jpeg" } }
-
-// Request signed upload URLs
-{ "type": "get-upload-url", "requestId": "abc123",
-  "payload": { "files": [{ "fileName": "photo.jpg", "mimeType": "image/jpeg", "sizeBytes": 1048576 }] } }
-
-// WebRTC offer
-{ "type": "offer", "payload": { "toUid": "bob", "sdp": { ...RTCSessionDescription } } }
-
-// WebRTC answer
-{ "type": "answer", "payload": { "toUid": "alice", "sdp": { ...RTCSessionDescription } } }
-
-// ICE candidate
-{ "type": "ice-candidate", "payload": { "toUid": "bob", "candidate": { ...RTCIceCandidate } } }
-
-// WS relay fallback (when ICE fails)
-{ "type": "relay", "payload": { "toUid": "bob", "data": { ...anything } } }
-
-// Friend actions
-{ "type": "friend", "payload": { "action": "send-request", "targetUid": "bob" } }
-{ "type": "friend", "payload": { "action": "accept",       "targetUid": "alice" } }
-{ "type": "friend", "payload": { "action": "reject",       "targetUid": "alice" } }
-{ "type": "friend", "payload": { "action": "remove",       "targetUid": "bob" } }
-{ "type": "friend", "payload": { "action": "list" } }
-{ "type": "friend", "payload": { "action": "status", "targetUid": "bob" } }
-```
-
-### Server → Client
-
-```jsonc
-{ "type": "connected",      "payload": { "uid": "...", "socketId": "..." } }
-{ "type": "ice-servers",    "payload": { "iceServers": [...] } }
-{ "type": "offline-flush",  "payload": { "messages": [...], "count": N } }
-{ "type": "message",        "payload": { "fromUid": "...", "content": "...", ... } }
-{ "type": "peer-online",    "payload": { "uid": "bob" } }
-{ "type": "peer-offline",   "payload": { "uid": "bob" } }
-{ "type": "upload-url",     "payload": { "urls": [{ "signedUrl", "objectPath", "publicUrl" }] } }
-{ "type": "offer",          "payload": { "fromUid": "...", "sdp": {...} } }
-{ "type": "answer",         "payload": { "fromUid": "...", "sdp": {...} } }
-{ "type": "ice-candidate",  "payload": { "fromUid": "...", "candidate": {...} } }
-{ "type": "relay",          "payload": { "fromUid": "...", "data": {...} } }
-{ "type": "error",          "payload": { "message": "..." } }
-```
-
----
-
-## File Upload Flow
-
-```
-1. Client → server: { type: 'get-upload-url', payload: { files: [...] } }
-2. Server → Supabase: createSignedUploadUrl (no bytes transferred)
-3. Server → client: { type: 'upload-url', payload: { urls: [...] } }
-4. Client → Supabase: PUT file directly (server sees 0 bytes, HF RAM unaffected)
-5. Client → server: { type: 'message', payload: { type: 'media', content: publicUrl } }
-6. Server → recipient: deliver or queue offline
-```
-
----
-
-## File Structure
-
-```
-src/
-├── index.ts                    # Entry point, HTTP+WS server
-├── config.ts                   # All env vars, ICE server builder
-├── db/
-│   └── mongo.ts                # MongoDB connection, User + Message models
-├── redis/
-│   ├── presenceClient.ts       # Bucket 1: uid→socketId, online/offline
-│   └── messageClient.ts        # Bucket 2: offline message queue
-├── services/
-│   ├── connectionRegistry.ts   # In-process socket map + zombie pruner
-│   ├── supabaseService.ts      # Signed URL generation, file validation
-│   └── friendService.ts        # Friend request/accept/remove logic
-├── handlers/
-│   ├── connectionHandler.ts    # WS connect/disconnect, message router
-│   ├── signalingHandler.ts     # WebRTC SDP/ICE forwarding
-│   ├── messageHandler.ts       # Text/media delivery + offline queue
-│   ├── fileHandler.ts          # Upload URL generation
-│   └── friendHandler.ts        # Friend CRUD over WS
-├── middleware/
-│   └── rateLimiter.ts          # Token bucket, 20 conn/IP/60s
-├── models/
-│   └── friend.ts               # FriendRequest mongoose model
-└── utils/
-    ├── jwt.ts                  # Token verification (uid always from JWT)
-    ├── logger.ts               # Structured JSON logger
-    └── protocol.ts             # WS message types + safe serialization
-
-client-reference/
-└── client.ts                   # Browser client (copy into your frontend)
-```
+Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference