Install

With Docker

The repository is currently private, so there is no published image yet. Build it once, then run it.

git clone git@github.com:rootstuff/slick.git
cd slick
docker build -f docker/Dockerfile -t slick .
docker run -p 3000:3000 -v ./data:/data slick

Open http://localhost:3000. The first visit walks you through creating the owner account and the first workspace. That is the whole deployment: API, realtime gateway, web app, and background jobs in one process, with all state in the mounted volume.

Plan for TLS before you invite anyone

Browsers only expose the camera and microphone in a secure context, so calls do not work over plain http:// on a remote host. Push notifications need one too. See Deploying with TLS before you put this anywhere but your own machine.

What lands in the volume

/data
  slick.db        SQLite database, in WAL mode
  slick.db-wal    write-ahead log
  files/          uploads and generated thumbnails

Back it up by copying it, with the database taken through the backup command rather than copied while running.

From source

Requires Node 22 and pnpm.

pnpm install
pnpm build          # build the workspace packages once
pnpm dev            # server on :3000, web dev server on :5173

The dev server proxies /api and /ws to the server, so open :5173 and get hot reload. pnpm test runs the server suite; pnpm typecheck runs across every package.

Verify it works

curl localhost:3000/api/health
# {"ok":true,"name":"slick","version":"0.0.1"}

The health check runs a real query, so a response means the database is open and migrated, not just that the process is alive.