Getting Started

The fastest way to run OpenJam is with Docker Compose.

Quick Start (Docker)

git clone https://github.com/xiaotwu/openjam.git
cd openjam
docker compose up --build -d

Open http://localhost:8080 and create an account.

Development Setup

For local development, you'll run the backend and frontend separately.

Prerequisites

• Docker (for database services)
• Go 1.22+
• Bun or Node.js 20+

1. Start dependency services

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

This starts PostgreSQL, Redis, and MinIO.

2. Start the backend

cd server
cp .env.example .env
go run main.go

3. Start the frontend

Bun

cd app
bun install
bun run dev

npm

cd app
npm install
npm run dev

4. Open the app

• Frontend: http://localhost:5173
• Backend API: http://localhost:8080
• MinIO Console: http://localhost:9001

Creating a Board

1. Register a new account or sign in
2. You'll be placed on the default board
3. Use ?room=my-board in the URL to create named boards
4. Share the URL with collaborators to work together