Developer Guide
Engineering documentation for extending EloSync. New business capability ships as modules that mirror Leads and Tasks.
Core standards
| Document | Description |
|---|---|
| Documentation Governance | Same-PR docs rule — code + tests + docs |
| Module Development | Module Development Standard + Definition of Done |
| Module Development Guide | End-to-end engineer checklist |
| Module Architecture | Self-contained modules and ownership boundaries |
| Module Dependencies | Required vs optional; free vs billable dependencies |
| Module Licensing | Independent licensing convention |
| Entitlements | Module licensing vs Spatie authorization |
| Database | ERD / table dictionary |
| Object Storage | Wasabi / S3 uploads |
| Storage | Workspace content quota + pack SKUs |
| Frontend Build Artifacts | CI/CD → build-artifacts branch |
| Playwright | E2E suites (Central + Tenant) |
| Tenant Provisioning | Workspace create → default modules |
| Notification Architecture Contract | Frozen notification payload, batching, Reverb, registry |
Auth, RBAC & settings
| Document | Description |
|---|---|
| Authentication | Auth architecture, guards, reset flow |
| Tenant RBAC | Implementing workspace RBAC |
| Central Settings | Settings resolution & APIs |
| Multi-Provider Email | EmailManager, drivers, logs, queues, body capture, resend |
| Email Webhooks | Postmark/Mailgun delivery webhooks |
| Tenant Settings | Tenant configuration hierarchy |
| Tenant API & Webhooks | Integration API tokens + outbound event webhooks |
UI
| Document | Description |
|---|---|
| Shared UI | Design system and reuse strategy |
| Shared Layout | Shell, nav, and page structure |
| Module Tours | driver.js product tours on module list pages |
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 |
| Contacts | Contacts module engineering guide |
| Tasks | Tasks module engineering guide |
| Projects | Projects module engineering guide |
| ToDos | Personal ToDos module engineering guide |
| Opportunities | Opportunities + pipeline engineering guide |
| Quotations | Quotations module engineering guide |
| Contracts | Contracts module engineering guide |
| Invoices | Invoices module engineering guide |
| Payments | Payments module engineering guide |
| Credit Notes | Credit Notes module engineering guide |
| Estimates | Estimates module engineering guide |
| Communication Templates | Templates, placeholders, WhatsApp render |
| Personal IMAP/SMTP mailbox, sync jobs, templates, signatures | |
| Automation | Cross-module trigger → condition → action engine |
| Help Desk | Internal ticketing MVP engineering guide |
| Assets | Equipment / fixed-asset register (Operations, free) |
| Documents | Flat file library on Storage (Operations, free; hard Storage dep) |
| Knowledge Base | Internal articles Marketplace opt-in (Operations, free) |
Lead ingest & integrations
| Document | Description |
|---|---|
| Lead Source Driver Architecture | Shared pipeline for all lead ingestion drivers |
| Custom Lead Webhook | Per-tenant webhook ingress |
| Meta App Setup | Create Meta Developer App + wire EloSync / EloSync (operator guide) |
| Meta Lead Ads | Shipped — MetaLeadAdsDriver, OAuth, webhooks |
| WhatsApp Cloud Integration | Shipped MVP 1.0.0 — Cloud API inbox + templates |