Developer Guide
Engineering documentation for extending SaleOS. New business capability ships as modules that mirror Leads and Tasks.
Core standards
| Document | Description |
|---|---|
| Module Development | Module Development Standard + Definition of Done |
| Module Development Guide | End-to-end engineer checklist |
| Entitlements | Module licensing vs Spatie authorization |
| Database | ERD / table dictionary |
| Object Storage | Wasabi / S3 uploads |
| Frontend Build Artifacts | CI/CD → build-artifacts branch |
| Playwright | E2E suites (Central + Tenant) |
| Tenant Provisioning | Workspace create → default modules |
Auth, RBAC & settings
| Document | Description |
|---|---|
| Authentication | Auth architecture, guards, reset flow |
| Tenant RBAC | Implementing workspace RBAC |
| Central Settings | Settings resolution & APIs |
| Tenant Settings | Tenant configuration hierarchy |
UI
| Document | Description |
|---|---|
| Shared UI | Design system and reuse strategy |
| Shared Layout | Shell, nav, and page structure |
Billing
| Document | Description |
|---|---|
| Billing Engine | Gateway-agnostic invoicing |
| Payment Gateways Overview | Architecture & driver map |
| Payment Gateways | Implementing gateway drivers |
| Webhooks | Webhook reference |
| Stripe / Cashier | Cashier driver notes |
| Creem | Creem checkout and ops |
Modules
| Document | Description |
|---|---|
| Leads | Leads reference implementation |
| Tasks | Tasks module engineering guide |