Install#
Before you start#
- Windows PowerShell for the supplied development launcher.
- Python 3.13 or later and
uv. - A supported Node.js release and npm.
- Git.
- Authorised access to the private demarc source repository.
- About 1 GB of free space for dependencies and local data.
Install from source#
Obtain an authorised checkout from the maintainer and enter its root.
Create local configuration:
Copy-Item .env.example .envInstall the runtime and dashboard dependencies:
uv sync npm --prefix web installSeed the local database:
uv run python -m runtime.seed
Keep .env outside source control. Replace every example secret before the
service is reachable from another machine.
Verify#
Run the automated checks before configuring live providers:
uv run pytest
npm --prefix web run build
Both commands should complete without errors. The supplied verification script runs the same checks plus lint, type checking and a local smoke start:
.\scripts\verify.ps1
The script stops on the first failing step. Its smoke run forces fake speech and language providers on a temporary database, so a passing run proves local wiring only. It does not prove live carrier audio, message delivery or provider behaviour on a real number; verify those on the deployed service.
Then follow Local quickstart to start the services.
If it does not work#
| Symptom | Check | Recovery |
|---|---|---|
uv run pytest fails before any provider is configured |
Whether the failure names a missing dependency or a real assertion | A dependency error means the environment is incomplete; re-run the install step rather than configuring providers |
| The web build fails | Node's version against the prerequisites above | Install a supported Node release; the build is not tolerant of an older one |
| Both checks pass but the service will not start | That is a runtime problem, not an install one | Continue to Local quickstart, which starts demarc with fake providers |