Developer Documentation
Welcome to the Business M Developer Documentation. This section is designed for developers, contributors, and community members who want to run the Business M application stack locally, explore the architecture, or build new domain plugins.
Business M is an open-source, modular enterprise platform. The core repository is public, and anyone can clone it and run the entire stack on their local machine.
Getting Started
Section titled “Getting Started”If you are new to Business M, the fastest way to get up and running is to follow our step-by-step setup guide.
- Developer Setup Guide: Step-by-step instructions for installing prerequisites (uv, pnpm, Docker), initializing the workspace, and running the development server in either Monolithic or Enterprise mode.
Core Concepts & Architecture
Section titled “Core Concepts & Architecture”Business M is built on Framework M and utilizes a progressive scaling architecture. It can run as a single process or decompose into distributed macroservices without changing business logic.
- Architecture Overview: Deep dive into the three-tier architecture (Engine, Control Panel, Business Logic) and dependency injection patterns.
- Plugin System Guide: Learn how to extend Business M by creating your own domain plugins for both the backend and frontend.
Advanced Operations
Section titled “Advanced Operations”For running production-grade deployments, upgrading core dependencies, or understanding deep system flows:
- Deployment Guide: Learn how to deploy the platform using Docker Compose or Kubernetes Helm charts.
- Upgrade Runbook: Best practices for upgrading Framework M dependencies and resolving package lock conflicts.
- Journal Entry Walkthrough: A deep dive into the lifecycle of a journal entry, from browser submission to committed GL entry via the Bookkeeper engine.
Need Help?
Section titled “Need Help?”If you run into any issues during setup or development, please open an issue on our GitLab repository or reach out to the community forum.