How neves-nvs/santorini works
Project Type and Purpose
• This is a full‐stack, real‐time, web-based implementation of the board game Santorini.
• Frontend: 3D rendering (Three.js + Vite + TypeScript) for interactive game play.
• Backend: Node.js + Express + WebSocket + Kysely (SQL ORM) + Passport.js for authentication, game logic enforcement, persistence, and real-time messaging.
File Structure
Top level:
• packages/client → all UI, rendering, network code
• packages/server → HTTP/WebSocket API, controllers, services, repositories, migrations, tests
• assets, blog, workflows, docs
Notice patterns:
• Client uses MVC-style separation (model, controller, view, services).
• Server uses layered architecture (controllers → services → repositories), plus Express middlewares and WebSocket handlers.
• Database migrations under server/migrations.
• Tests separated into unit vs integration (HTTP + WebSocket).
README for Additional Insights
• Technologies: Node.js, Express, Kysely (SQL), Passport.js, Three.js, TypeScript.
• Flow: User authenticates → engages a game session → all moves/updates exchanged over WebSocket → persisted in DB.