Explanation & Concepts
Conceptual guides and background information on Framework M's design, architecture, and core systems. These guides help you understand the why behind the framework's features and implementation.
💡 Fundamentals
Understand the baseline mechanisms, lifecycle events, and core features of the framework.
- Developer Guide: A high-level overview of building applications with Framework M.
- User Guide: How to navigate and interact with applications from a user perspective.
- Framework Entry Points: Where code execution starts and how the app is bootstrapped.
- CLI & Worker Lifecycle: Process lifecycles for background jobs, schedulers, and terminal command loops.
- Tree Strategies: The architecture behind pluggable Nested Set and Adjacency List models.
🛠️ Metadata Engine
Learn how the framework uses metadata decoration to automate database generation, API endpoints, and client-side views.
- Metadata Discovery: How DocTypes are scanned and registered at startup.
- Multi-App Decoration: Extending core schemas and composing behavior across modular apps.
- Virtual State & Defaults: Handling calculated fields and runtime fallback states.
- Document Identity & GitOps: Uniquely identifying records and managing configuration as code.
🏛️ Architecture & Frontend
Dive deep into Hexagonal Architecture, frontend composition, and modern UI delivery.
- Framework UI Vision: The principles guiding our zero-cliff frontend philosophy.
- Distributed UI & Module Federation: Composing frontend micro-applications at runtime.
- Frontend DX: Hot-reloading, type generation, and state management pipelines.
- Shell Hydration Lifecycle: How client-side applications load, verify sessions, and mount plugins.
🔒 Security & Tenancy
Read about the architectural boundaries keeping multi-tenant systems secure and isolated.
- Security Design: Authentication protocols, CSRF, and BFF security boundaries.
- Authorization & Entitlements: Fine-grained Role-Based Access Control (RBAC).
- Tenancy Isolation: Database and application-level tenant partitioning strategies.
🔄 Migration & Evolution
Manage the long-term lifecycle of schemas, database versions, and app refactorings.
- Managing Schema Evolution: Prototyping schemas and deploying changes with Zero Downtime Migrations (ZDM).
- Dual-Track Migrations: Balancing declarative auto-syncing with imperative Alembic migrations.
- Deterministic Schema Migrations: Ensuring schema migrations run identically across environments.