Getting started

What you need before building a third-party module for Avanora Core.

Prerequisites

  • Node.js 20+ and pnpm 9+ (monorepo uses workspaces)
  • Docker Desktop for local Postgres, Redis, and optional simulated provisioning
  • @avanora/module-sdk — install from the private Verdaccio registry (npm install @avanora/module-sdk --registry http://127.0.0.1:4873) or the release tarball under packages/module-sdk/release/ (see package README)

Local platform

  1. From the repo root, run ./start.sh to boot Control (port 3001) and Core (port 3000).
  2. Use owner@example.tenant / welcome on Core admin to validate tenant RBAC.
  3. Run pnpm --filter @avanora/developer-portal dev to open this site on port 3005.
  4. Optional: pnpm dev starts every satellite app including marketing, docs, status, and Launch.

Two documentation sites

docs.avanora.org covers operating the platform (Control, Launch, tenant APIs). This portal (dev.avanora.org) is for module authors and integration partners building on Core.