Ga naar inhoud

Developer Guide

Deze pagina beschrijft de belangrijkste ontwikkelafspraken voor ERP-NL.

Repositorystructuur

backend/          FastAPI app, routers, services, modellen, migraties en connectors
frontend/         React SPA met routes, pages, componenten, hooks en API-client
shared/           gedeelde TypeScript schema-definities
scripts/          seed scripts, seedlib, docgen en quality helpers
docs/             documentatie en gegenereerde documentatie
tests/            frontend-, backend- en repositorytests

Backend

Nieuwe backendfunctionaliteit hoort de bestaande router- en servicelaag te volgen. Gebruik FastAPI routers, SQLAlchemy voor database-interactie, Pydantic voor schemas en de bestaande autorisatiehulpen voor permission checks.

Nieuwe migraties:

  • plaats je onder backend/migrations/versions/;
  • registreer je in backend/migrations/registry.py;
  • maak je idempotent;
  • voeg je niet toe aan de legacy baseline.

Frontend

Nieuwe frontendfunctionaliteit hoort aan te sluiten op de bestaande modules, routes, TanStack Query-patronen en componenten. Houd organisatiecontext en permissions zichtbaar in de UI-logica.

Tests en checks

Veelgebruikte checks:

npm test
pytest -q tests/backend
pytest -q tests/repository
npm run lint
npm run build

Voor bredere kwaliteitscontrole:

npm run quality:all
npm run quality:full

Generated docs

De repository bevat generated docs onder docs/generated. Wijzigingen aan routes, database, docgen of relevante broncode kunnen betekenen dat deze output moet worden vernieuwd met:

npm run docs:generate

Controleer generated docs met:

npm run quality:docs