Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Run and extend the Orvlin monorepo locally
packageManager field)git clone https://github.com/mehedihnb/orvlin.git
cd orvlin
pnpm install
pnpm run build
pnpm run dev
http://localhost:3000. Routes are served under /v1. The health check is GET /v1/health.
For the dashboard alone, proxied to the API on port 3000:
pnpm --filter @orvlin/web dev
| Path | Contents |
|---|---|
packages/api | Fastify API server. |
packages/core | Revenue engine: event store, ingestion, query, simulation. |
packages/cli | The orvlin command-line tool. |
packages/sdk-node, packages/sdk-python, packages/react | Client SDKs. |
packages/web | Dashboard (React and Vite). |
packages/shared | Shared types and schemas. |
pnpm run test # package tests
pnpm run typecheck # TypeScript checks
pnpm run lint # lint all packages
docs/ folder. To preview them locally:
npm i -g mintlify
cd docs
mintlify dev
http://localhost:3000.