Skip to main content

Introduction

Pipeline Status Python License: MIT Status: Pre-Alpha

Welcome to the Framework M documentation.

Build once. Scale forever.

Framework M is a modern, modular, metadata-driven full-stack framework designed for building scalable enterprise applications. It bridges the gap between rapid development velocity and enterprise-grade architecture.

Core Philosophical Pillars

The "M" in Framework M represents our three architectural foundations:

  • Modular: Built on Hexagonal Architecture (Ports & Adapters). Build a Modular Monolith for velocity and transparently decompose into Microservices for scale without a rewrite.
  • Multi-Tenant: Native, first-class support for multi-tenancy is baked into every layer—from the database to the API.
  • Metadata-Driven: Application behavior is defined by DocTypes (metadata) to accelerate development. This enables automatic CRUD, UI, and workflows with modern type safety.

Why Framework M?

Batteries-included frameworks deliver incredible initial velocity, but often lead to a "productivity cliff" when scale, enterprise integration, or complex deployment requirements arise.

Framework M is designed to provide Zero Cliff Architecture. You get the same rapid development experience—DocTypes, automatic CRUD, permissions, workflows—but built on enterprise-grade foundations from day one.

Quick Navigation

  • Quick Start: Get up and running in minutes.
  • Developer Guide: Deep dive into the framework architecture.
  • Architecture: Understand Hexagonal Architecture & Ports/Adapters.
  • Defining DocTypes: Learn about metadata-driven development.
  • ADRs: Understand the "why" behind our architecture decisions.
  • Checklists: Track the implementation progress of the framework.

For technical documentation and deployment details, please refer to the README.