Skip to content

Installation

This guide walks you through setting up a local Consystence development environment.

Prerequisites

Requirement Version Notes
.NET SDK 10.0+ dot.net/download
Node.js 22 LTS+ nodejs.org
PostgreSQL 15+ Local install or Docker
Docker 24+ Optional — for running PostgreSQL

PostgreSQL via Docker

If you don't have PostgreSQL installed locally, the quickest path is:

docker run -d --name consystence-pg \
  -e POSTGRES_USER=consystence \
  -e POSTGRES_PASSWORD=consystence \
  -e POSTGRES_DB=consystence \
  -p 5432:5432 \
  postgres:17

Clone the repositories

Consystence is split across two main services:

git clone https://github.com/consystence/consystence-server.git
git clone https://github.com/consystence/consystence-auth.git

Configure the database

Both services expect a DATABASE_CONNECTION_STRING environment variable. For local development:

export DATABASE_CONNECTION_STRING="Host=localhost;Database=consystence;Username=consystence;Password=consystence"

Tip

Add this to your shell profile (.bashrc, .zshrc) so it persists across sessions.

Start the auth service

The auth service handles identity, login, and token issuance.

cd consystence-auth
dotnet restore
dotnet run

The auth service starts on https://localhost:5100 by default.

Start the server

The server hosts the Orleans silo, SignalR hubs, and the API layer.

cd consystence-server
dotnet restore
dotnet run

The server starts on https://localhost:5000 by default.

First launch — setup wizard

When you open https://localhost:5000 for the first time, the setup wizard walks you through:

  1. Creating your admin account
  2. Creating your first organisation
  3. Creating your first site

Once complete, you're dropped into the site dashboard.

Verify everything is running

# Auth service health check
curl -s https://localhost:5100/health

# Server health check
curl -s https://localhost:5000/health

Both should return Healthy.

Next steps