Skip to main content

What you will learn

  • System prerequisites for running Clavion
  • How to install from source using Git and npm
  • How to install using Docker
  • How to verify your installation

Prerequisites

Install from source

1

Clone the repository

2

Install dependencies

This installs all workspace packages. better-sqlite3 compiles a native addon — if you see build errors, ensure you have a C++ toolchain installed (xcode-select --install on macOS, build-essential on Ubuntu).
3

Build TypeScript

Uses TypeScript project references (tsc -b) to build all packages in dependency order.
4

Run tests

Runs the full test suite (639+ tests). All tests should pass.

Install with Docker

For a containerized setup without local Node.js:
See Docker Compose Stack for the full multi-service setup.

Verify installation

Start the development server:
Check health:
Expected response:

Directory structure

After installation, the repository has this layout:

Next steps