Frappe Architecture Handbook

Frappe Framework
1

Github : erpnext_user_guide/docs/knowledge_base/frappe_architecture_handbook.md at main · sanjay-kumar001/erpnext_user_guide · GitHub

This handbook is a comprehensive, source‑code‑driven analysis of the Frappe v16 framework. It covers application lifecycles, frontend/backend execution flows, the Document ORM, report engines, bench internals, realtime architecture, hooks, and production‑safe extension patterns. All information is derived from the official Frappe v16 repository and supporting technical documents.

Table of Contents

  1. Introduction
  2. High‑Level Architecture
  3. Application Lifecycle
  • 3.1 Login Lifecycle
  • 3.2 Logout Lifecycle
  • 3.3 Boot Process
  1. Desk SPA Architecture
  2. Routing Lifecycle
  3. Form Lifecycle
  • 6.1 Frontend Form Events
  • 6.2 Backend Document Lifecycle
  • 6.3 Save, Submit, Cancel, Amend, Delete, Rename
  1. Child Table Lifecycle
  2. Permissions & Security
  3. Report Lifecycles
  • 9.1 Script Report
  • 9.2 Query Report
  1. List View & Other Views
  2. Workspace & Dashboard
  3. Notifications & Assignment
  4. Realtime & WebSockets
  5. Scheduler Architecture
  6. Worker & Background Jobs
  7. Bench Commands Deep Dive
  • 16.1 bench start
  • 16.2 bench restart
  • 16.3 bench migrate
  • 16.4 bench build
  1. Asset Pipeline & Build System
  2. Hooks Framework & Extension Points
  3. Migration System
  4. Production‑Safe Customization Strategies
  5. Source Code Reference Map
  6. Appendices
  • A. Form Event Matrix
  • B. Controller Hook Matrix
  • C. Migration Order
  • D. Bench Process List
  • E. Sequence Diagrams
5 Likes