Development

For everyday hosting, use deployment. This page is for contributors.

Run locally

Use Node 24 or newer. The Docker image uses Node 26.

npm ci
npm run dev

Open http://localhost:3000. The development server rebuilds and restarts when source files change. Node commands read your shell environment; they do not load app/.env. To enable local accounts:

export ACCOUNTS_DB=./data/accounts.sqlite
npm run dev

In PowerShell, use $env:ACCOUNTS_DB = './data/accounts.sqlite' instead of export.

Build a local container

From the repository root:

cp app/.env.example app/.env
docker compose -f app/compose.yaml up -d --build

Open http://localhost:3712. This setup reads app/.env and preserves accounts in a named volume.

Run checks

npm run check
npx playwright install chromium firefox webkit
npm run test:e2e
npm run test:e2e:platform

Command	Checks
`npm run check`	Lint, type checks, unit tests, and release tests
`npm run test:e2e`	Main browser suite
`npm run test:e2e:platform`	Chromium, Firefox, and WebKit smoke tests
`npm run build`	Compile TypeScript and assemble browser assets

Test commands build automatically. Release tests use mocked APIs and temporary repositories; they do not publish real releases. Browser traces are saved under test-results/. Open one with npx playwright show-trace <path-to-trace.zip>.

Find the code

Directory	Contents
`app/server/`	HTTP, WebSockets, accounts, and relay
`app/client/`	Browser markup, styles, TypeScript, and assets
`tests/`	Unit, browser, and release tests
`scripts/`	Build, release, and benchmark scripts
`deploy/`	Published-image hosting
`docs/`	Mintlify documentation
`maintainer/`	Security review and measurements
`dist/`	Generated output; not committed

The application is TypeScript; builds produce JavaScript ES modules. Browser assets are assembled in dist/app/public/.

Documentation

The site is evakage.docs.thesteau.com. Navigation and branding live in docs/docs.json. From docs/, run:

npx mint dev
npx mint validate
npx mint broken-links

See releases for publishing and contribution rules.

Get started

Using Evakage

Self-hosting

Contributing

Run locally

Build a local container

Run checks

Find the code

Documentation

​Run locally

​Build a local container

​Run checks

​Find the code

​Documentation

Run locally

Build a local container

Run checks

Find the code

Documentation