Skip to Content
TechnicalTechnical Documentation

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 dev

This 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/ui component library and @sustentus/services shared logic
  • Deployment — Vercel, Docker, CI/CD pipelines, and environment management
  • Demo Environment — Demo tenant setup, login credentials, snapshot management

Prerequisites

ToolVersion
Node.js>= 22
pnpm>= 10
GitLatest
VS CodeRecommended

Port Reference

ApplicationPort
Web platform3000
Marketing3001
Storybook3002
Documentation3003
Dashboards3005
Last updated on