52 lines
1.9 KiB
Markdown
52 lines
1.9 KiB
Markdown
# Project File Index (Quick Reference)
|
|
|
|
Use this index to quickly locate files and directories during development and in discussions.
|
|
|
|
## Top-Level
|
|
- compose.yaml / compose.override.yaml — Docker services.
|
|
- docker/ — Docker build contexts and configs (php Dockerfile, nginx vhost).
|
|
- composer.json / composer.lock — Dependencies and scripts.
|
|
- importmap.php — Importmap configuration for JS dependencies.
|
|
- phpunit.dist.xml — PHPUnit configuration.
|
|
- public/ — Web root (index.php, assets, static files).
|
|
- var/ — Cache and logs.
|
|
- vendor/ — Composer dependencies.
|
|
|
|
## Application Source (src/)
|
|
- src/Kernel.php — Symfony Kernel bootstrapping.
|
|
- src/Website/ — Marketing/public website area (controllers, templates under templates/website/).
|
|
- src/Game/ — Game area (controllers, templates under templates/game/).
|
|
- src/Entity/ — Doctrine ORM entities.
|
|
- src/Repository/ — Doctrine repositories.
|
|
|
|
## Configuration (config/)
|
|
- config/packages/ — Symfony bundles configuration (framework.yaml, cache.yaml, etc.).
|
|
- config/routes/ — Routing configuration files.
|
|
- config/routes/app.yaml — Imports attribute routes for both sites (Website and Game).
|
|
|
|
## Data & DB
|
|
- migrations/ — Doctrine migrations.
|
|
|
|
## Presentation
|
|
- templates/ — Twig templates.
|
|
- templates/website — Views for the public website.
|
|
- templates/game — Views for the game area.
|
|
- translations/ — i18n message files.
|
|
|
|
## Frontend Assets
|
|
- assets/app.js — Main JS entry (imports Stimulus, styles, etc.).
|
|
- assets/controllers/ — Stimulus controllers.
|
|
- assets/styles/ — Global styles.
|
|
- assets/vendor/ — Vendor frontend assets if any.
|
|
|
|
## Tests
|
|
- tests/ — Test suites for PHPUnit.
|
|
|
|
## Environment
|
|
- .env — Base environment configuration.
|
|
- .env.local — Local overrides (ignored).
|
|
|
|
## Notes
|
|
- Follow doc/CONTRIBUTING.md for code style and workflows.
|
|
- Email setup: see doc/email.md for dev Mailpit and production SendGrid configuration.
|