Development and Tests

Development and Tests

Local setup

Start PostgreSQL and the backend with the development Compose file, or provide a PostgreSQL database yourself. Configure local environment files from the committed examples.

Backend, from backend/:

pip install -r requirements.txt
alembic upgrade head
fastapi dev app/main.py

Frontend, from frontend/:

npm ci
npm run dev

The backend container entrypoint applies Alembic migrations before serving the API. When running outside Compose, apply migrations explicitly as shown above.

PLC-connected development

Use the Backend (FastAPI, PLC debugging) VS Code profile for an equipment-connected session. It avoids auto-reload, which would cancel the worker during a source reload. Prefer the simulated PLC tests for ordinary development; follow docs/opc-ua-integration.md before interacting with plant equipment.

Test commands

Backend suite:

cd backend
python -m pytest -q

Frontend commands are defined in frontend/package.json. Common commands include the configured Playwright end-to-end suite and preview harness; check the scripts before running them because browser dependencies may require installation.

When changing API contracts, migrations, PLC behavior, or order state handling, update the corresponding tests and documentation. See Contributing.