A SvelteKit web application for tracing administrative measures in sustainable communities

The development environment relies on Docker Compose so make sure it is installed on your system.

You can start the SvelteKit app in development mode with all dependent services:

docker compose up -d --build

Visit http://localhost:5173 to verify that it is up and running.

To use the identity provider service, add the following line to /etc/hosts:

127.0.0.1      keycloak

The identity provider is initialised with a sysadmin user. Use these credentials to sign in:

Email: [email protected]
Password: test

We use PostgreSQL with Slonik. Please read its about section before writing database queries.

Migrations are written in SQL and managed with golang-migrate/migrate. The tool provides a command for creating new migrations:

docker compose run --rm migrate create -ext sql NAME

This will produce two empty files in the migrate/sql folder, one for upgrading the schema and one for restoring the current state.

For end-to-end tests, we use Playwright. The tests are run automatically as part of the continuous integration workflow. To execute the tests locally run:

npx playwright install --with-deps
npx playwright test