Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.auvy.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
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 (repo compose); Qdrant and MongoDB run per docs/SETUP.md

​
Fast start

bun install
cp .env.example .env
bun dbs:up
bun dev
bun dev runs the API first, then the dashboard, agent-end, MCP, Connect, and bots in parallel (see root package.json). bun dev:all is an alias for bun dev. Open:
  • dashboard: http://localhost:3000
  • API: http://localhost:3001
  • agent-end: http://localhost:3002 (background worker; see apps/agent-end)
  • MCP: http://localhost:3003/mcp
  • Connect: http://localhost:3004
  • bots: http://localhost:3005 (Teams bot control + worker)

​
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 dev / bun dev:allFull stack: web, API, agent-end, MCP, Connect, bots
bun dev:webDashboard only
bun dev:apiAPI only
bun dev:agent-endAgent-end only
bun dev:mcpMCP server only
bun dev:connectConnect only
bun dev:botsBots app only
bun dev:docsMintlify docs dev server (Node 18–24; see apps/docs/README.md)
bun dev:killFree ports 3000–3005 if something is stuck
bun buildProduction build for the dashboard (apps/web)
bun build:docs / bun build:allValidate Mintlify docs / dashboard + docs
bun previewPreview the production dashboard build locally
bun typecheckTypecheck dashboard (apps/web)
bun typecheck:allTypecheck every workspace
bun typecheck:ciSame as CI: typecheck ./apps/* and ./packages/* via Turbo (SDK dist/ when required) + kernel verify — scripts/run-typecheck-ci.mjs
bun ci:localFrozen install + typecheck:ci + dashboard production build
bun lintPackage boundaries + Connect import boundaries
bun dbs:up / bun dbs:downStart or stop Redis (Docker Compose)

​
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 18–24 and rerun bun dev:docs
Ports already in useRun bun dev:kill
Port 3000 conflict between dashboard and MintlifyStop the dashboard or run docs on another port (Mintlify picks the next free port when 3000 is taken)
Connect features are failing in webEnsure both the API and Connect are running locally
Nuxt / Vercel build cannot resolve @auvy-synapse/connect-client/dist/...Run bun install from the repo root. nuxt.config resolves Connect URL from @auvy-synapse/kernel; Vite aliases workspace packages to packages/*/src. See Developer overview
Infra-backed features failCheck bun dbs:status and verify Redis, Qdrant, and MongoDB are up