Selegic CRM
Documentation for the Selegic CRM platform (server, web, apps and packages).
Welcome to the Selegic CRM documentation hub — the single place for developer guides, architecture notes, API references, and examples for the CRM platform (server, web apps, extensions and shared packages).
CRM Server
Runtime, routes, CRUD, Dynamic Objects, Flows and Extensions.
Flow Automation
Durable, observable business automation and the Flow engine.
Extensions Guide
Build secure frontend extensions and server-side actions.
Database Migrations
Apply CRM Prisma migrations through Cloud SQL Proxy.
Developer & Repo map
Where code lives and how to contribute — apps, packages and examples.
Quick start ⚡
Clone the monorepo, install deps and start the CRM docs or full CRM development set:
# from repository root
pnpm install
# run CRM docs only
pnpm --filter crm-docs dev
# run CRM apps and packages (recommended for development)
pnpm dev:crmTips: use
pnpm dev:crmduring feature work to run server + web apps together. Usepnpm --filter crm-docs types:checkto validate MDX types.
Repository map — where things live 🔧
| Component | Path | Purpose |
|---|---|---|
| CRM Docs site | crm/docs | MDX docs, search API and docs UI (this site). |
| CRM Server | crm/server | Backend runtime: routes, CRUD, Flows, Extensions, pub/sub. |
| Examples & demos | examples/* | Custom apps — will be supported later. |
| Shared packages | packages/* | auth, db, schema, ui, shared-types, etc. Reusable building blocks. |
Key concepts & pages to read 📚
- Server (
/docs/server) — architecture, middleware, routes and feature-level docs (CRUD, dynamic objects, hooks). - Flows (
/docs/server/flows) — durable automation engine, execution model, APIs and persistence. - Extensions (
/docs/server/extensions) — frontend extension lifecycle, tokens, and server actions. - Metadata & Dynamic Objects — schema-driven entities with validation, hooks and runtime behavior.
Authoring docs & contribution guide ✍️
- Add new pages as MDX under
crm/docs/content/docs/. - Use the existing components:
<Cards>,<Card>,CodeBlock, diagrams and frontmatter for metadata. - Validate your changes locally with:
pnpm --filter crm-docs dev # preview docs
pnpm --filter crm-docs types:check # MDX + TS check- Update or add examples under
examples/and reference them from docs. - For code changes, follow the repo
README.mdand open a PR against theDevbranch.
Quick examples — common tasks
Run server-only (local dev)
# run CRM server feature set via turbo
pnpm dev:crmBuild docs for publishing
pnpm --filter crm-docs buildNeed help / next steps ✅
- Browse feature-level docs:
server→flows→extensionsfrom the left nav. - Want a new page added here? Create an MDX file in
crm/docs/content/docs/and open a PR.
Note: This doc is the central landing page for CRM-related docs — server, web, apps and shared packages. If you'd like, I can add a "Getting started" walkthrough or a dedicated "Packages reference" table next.