How fan2shrek/kard works
Project type and purpose
• This is a full‑stack, real‑time online card‑game platform (“Kard”) built on Symfony 7 with a React/Stimulus/Turbo front end.
• It supports multiplayer game sessions, admin management (EasyAdmin), payments (Stripe), real‑time updates (Mercure), and persistence (Doctrine + migrations).
File structure
• Top‑level directories:
• assets/ (frontend code: Stimulus controllers + a React app under assets/react)
• src/ (Symfony code: Api, Controllers, Domain, Entity, Service, Security, etc.)
• config/, public/, templates/ (standard Symfony MVC)
• .devops/, Dockerfile & compose.yaml (containerization)
• migrations/, DataFixtures/ (DB schema & seed data)
• tests/ (PHPUnit/Pest integration & feature tests)
• Key architectural hints:
• src/Domain, src/Service/GameManager – a domain‑driven design around game logic
• src/Controller/Api and assets/react – a SPA or partial‑page React UI calling REST endpoints
• Mercure bundle in config/packages/mercure.yaml & Stimulus/Turbo in assets – event‑driven real‑time UX
README
• Confirms stack: Symfony, React (Symfony UX), Stimulus, Turbo, Mercure, Docker, EasyAdmin
Main components & their interactions
a. Frontend Client
• Stimulus controllers (assets/controllers/*.js) and a React app (assets/react/)
• Uses Turbo for navigation/updating views; subscribes to Mercure updates via useMercure.js
b. Symfony Backend
• Public entry: public/index.php → Kernel → Router → Controllers (src/Controller & src/Controller/Api)
• Renders Twig templates (templates/) and serves the React bundle or API JSON
• Handles domain logic via services (src/Service), commands (src/Domain/Command + Messenger), and repositories (src/Repository)
• Admin UI via EasyAdmin controllers (src/Controller/Admin)
c. Persistence & Caching
• Relational DB (MySQL/PostgreSQL) via Doctrine (config/packages/doctrine.yaml + migrations/)
• Redis for caching or transient game state (src/Service/Redis)
• Symfony Messenger for async tasks (email, leaderboard generation)
d. Real‑time & External Services
• Mercure hub (config/packages/mercure.yaml) pushes game state/events to clients
• Stripe API for payments via src/Service/StripeClient
e. DevOps & CI/CD
• Dockerized environment (.devops/docker, compose.yaml, Makefile)
• GitHub Actions workflows for lint, tests, image updates
Architectural patterns & design principles
• MVC for web requests (Controllers, Twig templates, Entities/Repositories)
• Hexagonal/Domain‑Driven substructure (src/Domain + src/Service/GameManager)
• Event‑driven & real‑time via Mercure and Symfony Messenger
• Separation of concerns: UI vs. API, business logic in services, persistence in repositories
1. Web Browser (User)
2. Frontend Assets
• Stimulus/Turbo controllers
• React SPA bundle
3. Symfony App
• HTTP Kernel & Router
• MVC Controllers & API Controllers
• Business Services & Domain Layer
• Message Bus (Messenger)
4. Database (Doctrine ORM)
5. Redis Cache
6. Mercure Hub (Real‑Time Server)
7. Stripe (External Payment API)
• Browser → Symfony (HTTP requests)
• Symfony → Browser (HTML/Twig, JSON API, Turbo Streams)
• Symfony → Mercure Hub (UPDATE events) → Browser
• Symfony → Database (CRUD via Doctrine)
• Symfony → Redis (cache reads/writes)
• Symfony → Stripe API (payment requests)
• Symfony → Symfony Messenger → (async handlers, e.g., email, leaderboard)
• Blue rectangles for frontend components
• Green rectangles for backend components
• Top lane: User & Browser
• Middle lane: Frontend (Stimulus + React)
• Core lane: Symfony HTTP layer & Domain services
• Bottom lane: Infrastructure (DB, Redis, Mercure, Stripe, Messenger)