Quickstart

Leap ships as a single binary and needs PostgreSQL. This guide is a procedure. It shows how to install Leap and start it.

You can run Leap in three ways:

• with Docker Compose (development),
• with Docker Compose (production),
• as a single binary.

Prerequisites

• Docker and Docker Compose (for the Docker methods).
• just (for the development and build-from-source methods).
• Go 1.25+ and Node 22+ (for a build from source).
• pnpm (for a build from source).

Run with Docker Compose (development)

1. Start the development stack:

   just docker-up

2. Open http://localhost:9000 in a browser.

3. Log in with admin@admin.com and the password admin.

The development stack also starts a database browser (pgweb) at http://localhost:8081.

The credentials above work only in the development stack. Production refuses them.

Run with Docker Compose (production)

1. Copy the example environment file:

   cp docker/.env.example docker/.env

2. Edit docker/.env. Set JWT_SECRET, SUPERADMIN_EMAIL, SUPERADMIN_PASSWORD, POSTGRES_PASSWORD, and DB_PASSWORD. Use the same value for the two database passwords.

3. Start the stack:

   docker compose -f docker/docker-compose.yml up -d

4. Open http://localhost:9000 in a browser.

5. Log in with your SUPERADMIN_EMAIL and SUPERADMIN_PASSWORD.

If a secret is missing, or a placeholder remains, the application exits immediately. It starts only when every secret is real.

Run as a single binary

1. Generate a config file:

   ./crm --new-config config.toml

2. Edit config.toml. Replace every placeholder secret.

3. Start PostgreSQL. You can use any existing instance.

4. Run the binary:

   ./crm

The migrations run automatically at startup. They are idempotent, so a restart is safe.

The server refuses to start with placeholder or empty secrets.

Build from source

1. Start PostgreSQL in Docker:

   just dev-db

   The command also starts the database browser (pgweb) at http://localhost:8081.

2. Build the binary:

   just build

The binary is at bin/crm. It contains the frontend and the migrations, so it runs anywhere without extra asset directories.

For a full local environment, read the Development guide.

What is next?

• Read the Features page for a tour of the product.
• Read the API Reference to explore the REST API.
• Run the tests with just check. The command runs format, vet, lint, and tests.