How elkofix/bioethics-hook-game works
Project type and purpose
• This is a single-page, full-stack web application built with Next.js (using the new “app” router) that leverages Firebase as a backend-as-a-service.
• Purpose: an interactive bioethics game for live presentations. The presenter controls the game via an /admin panel, participants vote in real time, and results are displayed on a /results page.
File structure
• Top-level config: next.config.ts, tsconfig.json, postcss.config.mjs, eslint.config.mjs.
• src/app: Next.js routes—page.tsx at root, /admin/page.tsx, /results/page.tsx.
• src/app/components: UI building blocks grouped by feature (admin, simulation, results).
• src/core/simulation: pure-TypeScript simulation logic (Entity, constants).
• src/services/simulationService.ts: wraps Firebase read/write operations.
• src/lib/firebase.ts: initializes Firebase SDK.
• public & images: static assets for welcome screen and finals.
README
• Describes user flows: presenter activates/deactivates game, audience votes, real-time results.
• Calls out Firebase Hosting as one target, but could also be deployed on Vercel/Netlify/GitHub Pages.
• No custom backend code—data stored in Firestore (or Realtime Database) via the Firebase SDK.
Main components
a. Frontend (Next.js app)
• Routes:
• / (welcome & play screen)
• /admin (presenter controls)
• /results (aggregated stats)
• Components: simulation UI, results charts/cards, admin control cards.
• Core simulation module (entities, constants, drawingUtils).
• simulationService: API layer to Firebase.
b. BaaS (Firebase)
• Firestore (or Realtime DB) collections:
• session state (active/inactive)
• votes (per user choice)
• SDK initialized in src/lib/firebase.ts
c. Hosting & Deployment
• Firebase Hosting / Vercel / Netlify / GitHub Pages serving the built Next.js site.
d. Users
• Presenter (admin client)
• Audience (multiple browser clients)
Relationships & data flow
• All browser clients load the same Next.js bundle.
• simulationService subscribes to “session active” flag in Firebase.
• When presenter toggles “Activate Game”, admin UI writes to Firestore → all clients get update.
• Audience clients write their vote to a “votes” collection.
• On “Deactivate Game”, Firestore flag flips → clients switch to final modal.
• Results page queries Firestore for vote counts and displays charts/stats.
Architectural patterns & principles
• Feature-based component organization (admin, simulation, results).
• Separation of concerns:
• UI components (src/app/components)
• Domain logic (src/core/simulation)
• Data/service layer (src/services)
• Infrastructure code (src/lib/firebase)
• Event-driven, real-time updates via Firebase’s pub/sub model.