How wintermute84/retro-chat works
Project type and purpose
• This is a full-stack, real-time web chat application (“Retro Chat”) with a pixel-art, dial-up vibe.
• The front end is built as a Single Page Application (SPA) using React + Vite + TailwindCSS.
• The back end is a Node.js + Express server using Socket.IO for real-time WebSocket messaging.
• Features include temporary chat rooms, custom avatars/usernames (stored in browser localStorage), classic sound effects (Howler.js), fake loading/boot sequence, auto-reconnect, and an in-memory lobby (no database persistence).
File structure
• Top-level files:
• index.html, public/ — static host entrypoint and unprocessed assets
• package.json, vite.config.js, eslint.config.js — build, lint, and dependency settings
• src/ — all React components, styles, client-side logic:
– App.jsx, main.jsx, index.css — SPA bootstrapping, global styles
– chat.jsx, chatHeader.jsx, chatLog.jsx, chatOptions.jsx, loading.jsx, profile.jsx, userSettings.jsx — UI modules
– socket.js — Socket.IO client setup and event handling
• No server code in this repo: assume the back end lives in a separate “server” folder or repository.
README for additional insights
• Highlights the real-time chat functionality and tech stack.
• Mentions:
• React + Vite for fast development & HMR
• TailwindCSS for styling, clsx for conditional classes
• Socket.IO for real-time messaging
• Node.js + Express on the server side
• Howler.js for audio playback
a. Main components:
– Client Browser
• React SPA (App.jsx → components)
• TailwindCSS styling
• Howler.js sound engine
• LocalStorage for user/avatar settings
• Socket.IO client (socket.js)
– Backend Server
• Node.js + Express HTTP server
• Socket.IO server instance
• In-memory chat room management (no DB)
– Infrastructure & DevOps
• Vite dev server or built assets served by a static host/CDN
• Load balancer or reverse proxy (e.g., Nginx) for production
• Optional logging/monitoring service
b. Relationships and interactions:
– Client loads index.html → downloads SPA assets from static host/CDN
– React App initializes → connects to Socket.IO server over WebSocket
– User events (join room, send message) → Socket.IO emit → server processes, routes messages to target rooms → server emits events back → client listens and updates UI
– Connection lifecycle events (connect, disconnect, reconnect) managed by Socket.IO’s auto-reconnect
– Sound effects triggered on client events via Howler.js
– User preferences (username, theme) read/written to browser localStorage
c. Architectural patterns/design principles:
– Component-based UI (React) with separation of concerns
– Real-time pub/sub pattern via WebSockets (Socket.IO)
– Stateless front end; stateful in-memory rooms on server
– No persistent storage—ephemeral chat rooms vanish when server restarts or all users disconnect
– Single responsibility: client handles UI/UX, server handles message routing
d. Relevant technologies/frameworks:
– React + Vite (SPA bundling, HMR)
– TailwindCSS + clsx (utility-first styling)
– Socket.IO (bidirectional WebSocket abstraction)
– Node.js + Express (HTTP/WebSocket server)
– Howler.js (audio playback)