Skip to main content

​
Local Development

This page is the contributor-facing quick path for running the monorepo. The deeper internal source of truth still lives in docs/SETUP.md.

​
Prerequisites

  • Bun >= 1.0
  • Node.js 18-24 for the Mintlify docs app
  • Docker for Redis, Qdrant, and MongoDB

​
Fast start

bun install
cp .env.example .env
bun dbs:up
bun dev:all
Open:
  • dashboard: http://localhost:3000
  • API: http://localhost:3001
  • MCP: http://localhost:3003/mcp
  • Connect: http://localhost:3004

​
Docs workflow

Mintlify requires Node.js < 25, so use Node 20 when working on apps/docs: 
fnm use 20
bun dev:docs
Validation commands: 
bun run docs:validate
bun run docs:check-links

​
Common commands

CommandPurpose
bun devRun the dashboard only
bun dev:apiRun the API only
bun dev:mcpRun the MCP server only
bun dev:connectRun Connect only
bun dev:docsRun the docs app
bun typecheck:allTypecheck every workspace
bun dbs:up / bun dbs:downStart or stop local infrastructure

​
Environment notes

  • The repo uses a single root .env
  • AUVY_AUTH_SUPABASE_* covers auth/platform data
  • AUVY_PRODUCT_SUPABASE_* covers product/workspace data
  • Most apps load the root .env automatically

​
Troubleshooting

IssueFix
Docs fail to startSwitch to Node 20 and rerun bun dev:docs
Ports already in useRun bun dev:kill
Connect features are failing in webEnsure both the API and Connect are running locally
Infra-backed features failCheck bun dbs:status and verify Redis, Qdrant, and MongoDB are up