Packages Overview¶
CoreForge Web is organized as a monorepo with focused, composable packages.
Package Dependency Graph¶
┌─────────────────────────────────────────────────────────────┐
│ Application │
└─────────────────────────────────────────────────────────────┘
│
┌─────────────────────┼─────────────────────┐
▼ ▼ ▼
┌───────────────┐ ┌───────────────┐ ┌───────────────┐
│ @coreforge │ │ @coreforge │ │ @coreforge │
│ /shell │ │ /pages │ │ /telemetry │
└───────────────┘ └───────────────┘ └───────────────┘
│ │ │
└─────────────────────┼─────────────────────┘
│
┌─────────────────────┼─────────────────────┐
▼ ▼ ▼
┌───────────────┐ ┌───────────────┐ ┌───────────────┐
│ @coreforge │ │ @coreforge │ │ @coreforge │
│ /auth │ │ /tenant │ │ /api-client │
└───────────────┘ └───────────────┘ └───────────────┘
│
▼
┌───────────────┐
│ @coreforge │
│ /design-tokens│
└───────────────┘
Package Summary¶
| Package | Purpose | Key Exports |
|---|---|---|
| @coreforge/auth | Authentication | AuthProvider, ProtectedRoute, useAuth |
| @coreforge/tenant | Multi-tenancy | TenantProvider, RequireRole, useOrganization |
| @coreforge/api-client | HTTP client | ApiProvider, useApi, createClient |
| @coreforge/telemetry | Instrumentation | TelemetryProvider, ErrorBoundary |
| @coreforge/shell | App layout | AppShell, Sidebar, Navbar |
| @coreforge/pages | Pre-built pages | LoginPage, ErrorPage |
| @coreforge/design-tokens | Design system | Colors, typography, spacing |
Choosing Packages¶
Minimal Setup:
Full Application:
pnpm add @coreforge/auth @coreforge/tenant @coreforge/api-client \
@coreforge/shell @coreforge/pages @coreforge/telemetry
Design System Only: