How jainsamyak15/masskribbl works
Project Type and Purpose
• Frontend: Next.js app (React + TypeScript + Tailwind + Radix UI + Framer Motion).
• Real-time layer: Socket.IO server (Node.js).
• Persistence & auth: Supabase (Postgres + Auth).
• State management: Zustand.
• Utilities & word lists on both client (lib/words.ts) and server (server/words.js).
High-Level Architecture Components
A. Frontend (Next.js)
• Pages & routing (app/ directory)
– Home / Lobby (/page.tsx, lobby create/join/quick)
– Game room (/game/[roomCode]/page.tsx)
• UI Components (components/auth, /lobby, /game, /ui)
• Global styles: Tailwind (app/globals.css)
• Client libraries (lib/)
– Socket.IO client (lib/socket.ts)
– Supabase client (lib/supabase.ts)
– Zustand store (lib/store.ts)
– Utility modules (lib/utils.ts, lib/words.ts)
B. Real-Time Backend (Node.js + Socket.IO)
• socket-server.js: handles namespace, events (joinRoom, startGame, drawStroke, chatMessage, endTurn)
• words.js: server-side word lists & random selection
• supabase.js: optional persistence calls (game history, user events)
C. Database & Auth (Supabase)
• Auth: email/username (NextAuth/Supabase Auth)
• Tables (via supabase/migrations/*.sql): users, rooms, games, scores, chat_log, word_history
• Realtime subscriptions (optional)
D. (Optional) Smart Contracts Module
• contracts/assembly: AssemblyScript contracts + tests (as-pect)
• contracts/src: scripts for deploy/test (deploy.ts, hello.ts, utils.ts)
• Used for blockchain-based features (if applicable) or just CI tests
E. Deployment & CI
• Frontend: Vercel or Netlify (Next.js build)
• Socket.IO Server: Railway/Heroku (Node.js)
• CI: GitHub Actions (contracts/.github/workflows/ci-tests.yml)
User Flow
1. User opens https://… → Next.js renders Home page.
2. Login/Signup via Supabase Auth (components/auth/LoginForm).
3. User chooses Quick Play / Create Room / Join Room → triggers API calls (app/api/socket/route.ts) or Socket.IO “createRoom” event.
4. Server assigns roomCode, persists in Supabase.
5. Clients join Socket.IO room → Zustand store updates player list.
6. Once ≥2 players, host clicks “Start Game” → server initializes game state, selects word choices.
7. Drawer client receives word list → draws on HTML5 Canvas (components/game/DrawingCanvas + DrawingTools).
8. Drawing strokes broadcast via Socket.IO “drawStroke” events → other clients render in real time.
9. Guessers send chat messages (components/game/GameChat) → server tests guesses vs target word.
10. On correct guess or timer expiry, server calculates points → updates Supabase & broadcasts new scores.
11. GameTimer counts down per turn (components/game/GameTimer) → loop until rounds complete.
12. End of game: leaderboard shown (components/game/PlayerList + Score display), history written to Supabase.
Architectural Patterns & Design Principles
• Separation of concerns: UI components vs state vs network logic.
• Event-driven real-time communication (Socket.IO pub/sub model).
• Centralized state management (Zustand) for cross‐component sync.
• API layer vs WebSocket layer: Next.js API routes for REST/HTTP needs, Socket.IO for bidirectional events.
• Modular directory layout: “app/” for pages, “components/” for UI, “lib/” for client utilities.