Lumbox Docs

Getting Started

Set up Lumbox locally.

Getting Started

Prerequisites

  • Node.js 18+ (20 recommended)
  • Bun 1.2+ (package manager)
  • PostgreSQL — local, Neon (free tier), or any Postgres provider

Setup

# Clone and install
git clone https://github.com/Lumbox/Lumbox.git
cd Lumbox
bun install

# Configure environment
cp .env.example .env
# Edit .env — at minimum set DATABASE_URL

Minimal .env

DATABASE_URL="postgresql://user:password@localhost:5432/lumbox"
DEFAULT_DOMAIN="lumbox.co"
INBOUND_SECRET="any-random-string"

Database

Push the Prisma schema to your database:

cd apps/api
bun run db:push

To explore data visually:

bun run db:studio

Start Development

# Start everything (API + dashboard)
bun run dev

# Or start individual apps
cd apps/api && bun run dev       # API on :3000
cd apps/web-new && bun run dev   # Dashboard on :3001
cd apps/mcp-server && bun run dev      # MCP stdio mode
cd apps/mcp-server && bun run dev:http # MCP HTTP mode on :3002

Create an Organization + API Key

# Create an org
curl -X POST http://localhost:3000/v1/orgs \
  -H "Content-Type: application/json" \
  -d '{"name": "my-org"}'
# Response includes api_key: "ak_..."

# Test the API key
curl http://localhost:3000/v1/inboxes \
  -H "X-API-Key: ak_your_key_here"
# → { "data": [] }

Create Your First Inbox

curl -X POST http://localhost:3000/v1/inboxes \
  -H "X-API-Key: ak_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{"name": "test-inbox"}'
# → { "id": "inb_...", "address": "abc123@lumbox.co", ... }

Next Steps