index.md
1.57 KB
vibe_erp documentation
vibe_erp is an ERP/EBC framework for the printing industry, designed so customer-specific workflows are assembled by configuration and plug-ins instead of by forking the core. This index is the entry point to the framework's own documentation. The full architecture spec lives at superpowers/specs/2026-04-07-vibe-erp-architecture-design.md and is the source of truth for everything in this tree.
Guides
| Guide | What it covers |
|---|---|
| Architecture overview | Clean Core philosophy, two-tier extensibility, PBCs, the dependency rule, multi-tenancy, custom fields, the workflow engine. |
| Plug-in API overview | What api.v1 is, the package layout, the stability contract, the A/B/C/D extension grading. |
| Plug-in author getting started | A concrete walkthrough for building, packaging, and loading your first vibe_erp plug-in. |
| Workflow authoring guide | BPMN 2.0 workflows on embedded Flowable: visual designer (Tier 1) and .bpmn files in plug-ins (Tier 2). |
| Form authoring guide | JSON Schema + UI Schema forms: visual designer (Tier 1) and JSON files in plug-ins (Tier 2). |
| i18n guide | ICU MessageFormat, message bundles, locale resolution, tenant overrides, shipping locales. |
| Customer onboarding guide | Integrator's checklist for standing up a new vibe_erp customer end-to-end. |