Technical Documentation
Developer guides for the Sustentus monorepo covering local setup, architecture, build tooling, and deployment.
Quick Start
git clone <repository-url>
cd sustentus
pnpm install
pnpm env:pull
pnpm devThis starts the web platform on http://localhost:3000, dashboards on http://localhost:3005, the marketing site on http://localhost:3001, and Storybook on http://localhost:3002.
Sections
- Getting Started — Prerequisites, installation, environment variables, and VS Code setup
- Architecture — Monorepo layout, workspace isolation, and data flow
- Development — Day-to-day workflow, build system, and error logging
- Applications — web platform, dashboards, marketing, docs, help, and Storybook
- Packages —
@sustentus/uicomponent library and@sustentus/servicesshared logic - Deployment — Vercel, Docker, CI/CD pipelines, and environment management
- Demo Environment — Demo tenant setup, login credentials, snapshot management
Prerequisites
| Tool | Version |
|---|---|
| Node.js | >= 22 |
| pnpm | >= 10 |
| Git | Latest |
| VS Code | Recommended |
Port Reference
| Application | Port |
|---|---|
| Web platform | 3000 |
| Marketing | 3001 |
| Storybook | 3002 |
| Documentation | 3003 |
| Dashboards | 3005 |
Last updated on