Getting started¶
Prerequisites¶
- Git
- Node.js 24.21.0 and npm 11.19.0 for the app
- Python 3.12.x and pip for documentation
These are the selected baseline versions recorded on 29 September 2026. Package registries confirmed the exact pinned releases; verify supported current platform releases before upgrading or deploying.
Set up¶
From the repository root, run:
bash scripts/setup.sh
The script checks the Node/npm versions, creates the npm lockfile with npm install only when one does not exist, otherwise uses npm ci, and creates an isolated docs environment with fully pinned Python requirements.
Run the app:
npm run dev:web
Build and validate it:
npm run validate:web
The app build does not invoke Python or build the docs. From /docs, a docs-only environment can be prepared and used without npm:
python3 -m venv .venv
. .venv/bin/activate
python -m pip install -r requirements.lock.txt
python scripts/build.py serve
For the full build use npm run build:all from the root.
Source logos, icons and fonts are already unpacked under packages/brand/assets. Both builds copy and verify them automatically. See Brand, Deployment and Agents and validation.