Quorum

Requirements

• Docker >=20.10.23
• just

Running With Docker

Starting the docker containers and opening the web app is as easy as:

just start

Running Frontend Locally

A svelte app server for the frontend of the Quorum app.

Local Requirements

• Node >=23.7.0
• npm >=11.1.0

Node/npm versioning

If you use nvm you can install the latest node and npm with:

nvm install node
npm install -g npm@latest

then verify versions:

node --version
npm --version

Running Locally

cd frontend
npm install
npm run open

Running Backend Locally

A FastAPI server for the backend API of the Quorum app.

Local Requirements

• python >=3.13
• poetry >=1.8.1
• uv >=0.5.26

Running Locally

1. Work from backend/

cd backend

2. Set up .env

cp .env.example .env

2. Install requirements

# Create virtual environment with uv
uv python install 3.13
uv venv --python 3.13
source .venv/bin/activate

# Install python packages with uv
uv sync

3. Run the server

# Run the backend server with fastapi
fastapi run --workers 1 quorum/main.py

Connect

2. Connect with xh http://0.0.0.0:8000/api/v1/stub/ x==y or websocat ws://0.0.0.0:8000/api/v1/ws/rpc