Skip to main content

Quickstart

Get the Shift Platform running locally in under 5 minutes. No Docker, no Kubernetes, no Doppler -- just Bun.

Prerequisites​

ToolVersionInstall
Bun>= 1.0curl -fsSL https://bun.sh/install | bash
GitanyPre-installed on macOS/Linux

Setup​

# 1. Clone with all submodules
git clone --recurse-submodules https://github.com/the-shift-dev/platform.git
cd platform

# 2. Install dependencies
bun install

# 3. Start all services + gateway
bun run dev

What You'll See​

The dev launcher starts all enabled services with color-coded output:

ServiceURL
Gatewayhttp://localhost:3000
Yellow Pages APIhttp://localhost:4001
Passport APIhttp://localhost:4002
Pulse APIhttp://localhost:4003
Ledger APIhttp://localhost:4004
Stage APIhttp://localhost:4005
Palette APIhttp://localhost:4006
Communication APIhttp://localhost:4007
Inference APIhttp://localhost:4008
Platform Webhttp://localhost:4100

Verify​

curl http://localhost:3000/healthz
# {"status":"ok","service":"shift-gateway","version":"0.1.0"}

Seed Sample Data​

Populate the platform with sample services, owners, and events:

bun run seed

Run Tests​

bun run test

Check Environment Health​

Verify that all dependencies and configurations are in order:

bun run doctor

Next Steps​