108 lines
4.4 KiB
Markdown
108 lines
4.4 KiB
Markdown
# Central
|
|
|
|
Application de gestion du SI Malio. Monorepo Symfony 8 (API Platform 4) + Nuxt 4.
|
|
|
|
## Stack
|
|
|
|
- **Backend** : PHP 8.4, Symfony 8.0, API Platform 4, Doctrine ORM, PostgreSQL 16
|
|
- **Frontend** : Nuxt 4 (SSR off / SPA), Vue 3, Pinia, Tailwind CSS, @malio/layer-ui, nuxt-toast, @nuxtjs/i18n, @nuxt/icon
|
|
- **Auth** : JWT HTTP-only cookie (lexik/jwt-authentication-bundle), login à `/login_check`, cookie `BEARER`
|
|
- **Docker** : PHP-FPM + Node 24, Nginx (port 8084), PostgreSQL (port 5436)
|
|
|
|
## Structure
|
|
|
|
```
|
|
src/Entity/ # Entités Doctrine (User)
|
|
src/ApiResource/ # Ressources API Platform (AppVersion)
|
|
src/State/ # Providers et Processors API Platform (MeProvider, AppVersionProvider, UserPasswordHasherProcessor)
|
|
src/Repository/ # Repositories Doctrine
|
|
src/DataFixtures/ # Fixtures
|
|
config/ # Config Symfony (security, api_platform, lexik_jwt, nelmio_cors, doctrine)
|
|
config/jwt/ # Clés JWT (private.pem, public.pem)
|
|
migrations/ # Migrations Doctrine
|
|
frontend/ # App Nuxt 4
|
|
frontend/pages/ # Pages (index, login)
|
|
frontend/layouts/ # Layouts (default, auth)
|
|
frontend/components/ # Composants Vue (ui/SidebarLink, ui/AppTopNav)
|
|
frontend/composables/# Composables (useApi, useAppVersion)
|
|
frontend/stores/ # Stores Pinia (auth, ui)
|
|
frontend/services/ # Services API (auth)
|
|
frontend/services/dto/ # Types TypeScript
|
|
frontend/i18n/locales/ # Fichiers de traduction
|
|
```
|
|
|
|
## Commandes
|
|
|
|
```bash
|
|
make start # Démarrer les containers
|
|
make stop # Arrêter les containers
|
|
make restart # Redémarrer les containers
|
|
make install # Install complet (composer, migrations, fixtures, build Nuxt)
|
|
make reset # Tout supprimer et réinstaller (supprime la BDD)
|
|
make dev-nuxt # Dev server Nuxt (hot reload, port 3003)
|
|
make shell # Shell dans le container PHP
|
|
make shell-root # Shell root dans le container PHP
|
|
make cache-clear # Vider le cache Symfony
|
|
make migration-migrate # Lancer les migrations
|
|
make fixtures # Charger les fixtures
|
|
make db-reset # Reset BDD + migrations + fixtures
|
|
make test # PHPUnit
|
|
make php-cs-fixer-allow-risky # Fix code style PHP
|
|
make logs-dev # Tail logs Symfony
|
|
```
|
|
|
|
## Conventions
|
|
|
|
### Commits
|
|
|
|
Format : `<type>(<scope optionnel>) : <message>` (espace avant et après `:`)
|
|
|
|
Types autorisés (minuscules) : `build`, `chore`, `ci`, `docs`, `feat`, `fix`, `perf`, `refactor`, `revert`, `style`, `test`
|
|
|
|
Exemples : `feat : add login page`, `fix(auth) : prevent null token crash`
|
|
|
|
### Tags & Versioning
|
|
|
|
- La version de l'app est dans `config/version.yaml` (paramètre `app.version`)
|
|
- À chaque création de tag, **toujours** mettre à jour `config/version.yaml` avec la même version
|
|
- Faire un commit séparé de bump : `chore : bump version to v<X.Y.Z>`
|
|
- Puis créer le tag et pusher : `git tag v<X.Y.Z> && git push origin main --tags`
|
|
|
|
### Backend
|
|
|
|
- Toujours `declare(strict_types=1)` en haut des fichiers PHP
|
|
- API Platform : utiliser ApiResource, Providers (`src/State/`), Processors — pas de controllers
|
|
- Routes API préfixées `/api` (via `config/routes/api_platform.yaml`)
|
|
- Le login (`/login_check`) est hors prefix `/api`, nginx réécrit `REQUEST_URI` vers `/login_check`
|
|
- PHP CS Fixer : règles Symfony + PSR-12 + strict types
|
|
- Rôles : `ROLE_ADMIN`, `ROLE_USER` — hiérarchie dans `security.yaml`
|
|
- Controllers custom sous `/api/` : ajouter `priority: 1` sur `#[Route]` pour éviter le conflit avec API Platform `{id}`
|
|
|
|
### Frontend
|
|
|
|
- TypeScript strict
|
|
- Composable `useApi()` pour tous les appels API (gère cookies, erreurs, toasts, i18n)
|
|
- Stores Pinia : `useAuthStore` (auth), `useUiStore` (ui)
|
|
- Middleware global `auth.global.ts` protège les routes
|
|
- Traductions dans `frontend/i18n/locales/` (le module résout `langDir` depuis `i18n/`)
|
|
- 4 espaces d'indentation
|
|
|
|
### Nginx
|
|
|
|
- `/api/*` → Symfony (via try_files + index.php)
|
|
- `/api/login_check` → location exact match, fastcgi direct avec REQUEST_URI réécrit en `/login_check`
|
|
- `/` → SPA frontend (`frontend/dist/`)
|
|
|
|
## Docker
|
|
|
|
- Container PHP : `php-central-fpm`
|
|
- Container Nginx : `nginx-central`
|
|
- Container DB : PostgreSQL sur port **5436** (interne et externe)
|
|
- Config Docker : `infra/dev/.env.docker` (override local : `infra/dev/.env.docker.local`)
|
|
- Après modif nginx : `docker restart nginx-central`
|
|
|
|
## Fixtures
|
|
|
|
- User admin : `admin` / `admin` (ROLE_ADMIN)
|
|
- Users internes : `alice` / `alice`, `bob` / `bob` (ROLE_USER)
|