Files
breadcrumb-the-shire/docs/howto-lokale-entwicklung.md

99 lines
2.4 KiB
Markdown
Raw Normal View History

# Lokale Entwicklung
Letzte Aktualisierung: 2026-04-01
## Ziel
2026-03-04 15:56:58 +01:00
Kompakter Tagesworkflow für Entwicklung, Tests und schema-nahe Änderungen.
## First-Time Workflow
```bash
bin/dev init
```
`bin/dev init` ist nicht-destruktiv und führt aus:
1. `.env` aus `.env.example` erstellen (falls fehlend)
2. `docker compose up --build -d`
3. `module:sync`
4. `doctor`
## Start/Stop
```bash
bin/dev up
bin/dev down
```
2026-03-04 15:56:58 +01:00
Hinweis: `up -d` startet auch den Scheduler-Service.
2026-03-04 15:56:58 +01:00
Bei inkonsistentem Laufzeitverhalten:
```bash
docker compose restart php nginx
```
## Module-Sync
Nach Änderungen an Modulen, Manifesten oder `APP_ENABLED_MODULES`:
```bash
docker compose exec php php bin/console module:sync
```
Dieser Befehl führt automatisch aus: `migrate``permissions-sync``build``assets-sync`.
Falls `web/index.php` den Fehler "Module runtime is stale" wirft, ist der Sync nötig.
Alle verfügbaren CLI-Kommandos: `php bin/console list` (siehe `/docs/reference-cli-commands.md`).
Alle Dev-Orchestrator-Kommandos: `bin/dev --help`.
2026-03-04 15:56:58 +01:00
## Schema-Stand
- Basis-Schema + Seeds: `db/init/init.sql`
2026-03-04 15:56:58 +01:00
- Für Bestandsumgebungen: idempotente SQL-Updates in `db/updates/*.sql`
2026-03-04 15:56:58 +01:00
## Umsetzungsablauf
1. Requirement klären
2. Repository anpassen (SQL)
3. Service anpassen (Business-Regeln)
4. Action/Page anpassen
2026-03-04 15:56:58 +01:00
5. i18n ergänzen
6. Doku aktualisieren
2026-03-04 15:56:58 +01:00
## Pflichtchecks vor Commit
```bash
docker compose exec php vendor/bin/phpunit
docker compose exec php vendor/bin/phpstan analyse -c phpstan.neon --no-progress
```
Bei Modul-/Manifest-Änderungen zusaetzlich:
```bash
docker compose exec php php bin/console module:sync
```
2026-03-04 15:56:58 +01:00
Bei JS-Änderungen zusätzlich Browser-Smoke mit DevTools-Console (keine JS-Errors).
## Struktur-Gates (empfohlen)
```bash
(rg 'new\s+[^\s(]+Factory\(' core/Service || true) | wc -l
(rg --glob '!**/*Factory.php' 'new\s+[^\s(]+(Service|Gateway|Repository)\(' core/Service || true) | wc -l
2026-03-04 15:56:58 +01:00
(rg "\b(accessServicesFactory|directoryServicesFactory|userServicesFactory|authServicesFactory|tenantServicesFactory|settingServicesFactory|userRepositoryFactory|authRepositoryFactory|authGatewayFactory)\(" pages lib templates web || true) | wc -l
```
## API-spezifisch
2026-03-04 15:56:58 +01:00
- `docs/openapi.yaml` aktualisieren
2026-03-09 18:30:52 +01:00
- bei Bedarf `/docs/reference-api.md` ergänzen
- bei Security-Änderungen `/docs/explanation-sicherheitsmodell.md` aktualisieren
2026-03-04 15:56:58 +01:00
## Vertiefung
- `/docs/reference-entwickler-checkliste.md`
- `/docs/tutorial-04-architektur-request-flow.md`