# frappe/lms architecture

> Architecture diagram of the GitHub repository frappe/lms, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-09). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/frappe/lms
- Repository: https://github.com/frappe/lms

## Overview

Frappe Learning is a learning-management system for authoring courses and delivering instruction to learners. Its principal workflow is to structure courses into chapters and lessons, enroll learners individually or in batches, deliver lesson content and live classes, assess progress through quizzes and assignments, and award certificates. The frontend provides learner and instructor experiences; Frappe backend APIs and document controllers implement domain operations and access control. The README documents the major product capabilities, while source-index references support selected backend links; unsampled implementation details are not expanded into inferred call chains.

Main entry points: [`lms/lms/api.py`](https://github.com/frappe/lms/blob/develop/lms/lms/api.py) (LMS API), [`frontend/src/pages/Courses`](https://github.com/frappe/lms/tree/develop/frontend/src/pages/Courses) (Course pages), [`lms/lms/doctype/lms_live_class/lms_live_class.py`](https://github.com/frappe/lms/blob/develop/lms/lms/doctype/lms_live_class/lms_live_class.py) (Live classes), [`lms/lms/doctype/lms_batch_enrollment/lms_batch_enrollment.py`](https://github.com/frappe/lms/blob/develop/lms/lms/doctype/lms_batch_enrollment/lms_batch_enrollment.py) (Batch enrollment)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_experience["Learning experience"]
  node_app["Frontend app<br/>[App.vue]"]
  node_routes["Page routing<br/>[routes.js]"]
  node_course_pages["Course pages"]
  node_lesson_page["Lesson experience<br/>[Lesson.vue]"]
  node_review["Course reviews"]
end

subgraph group_authoring["Course authoring"]
  node_course_lesson["Lesson controller<br/>[course_lesson.py]"]
  node_course_import["Course import export"]
end

subgraph group_delivery["Enrollment and delivery"]
  node_batch_pages["Batch pages"]
  node_batch_controller["Batch management<br/>[lms_batch.py]"]
  node_bulk_enroll["Bulk enrollment<br/>[bulk_enrollment.py]"]
  node_enrollment["Course enrollment<br/>[lms_enrollment.py]"]
  node_batch_enrollment["Batch enrollment"]
  node_live_class["Live classes<br/>[lms_live_class.py]"]
end

subgraph group_assessment["Assessment and credentials"]
  node_quiz_pages["Quiz experience<br/>[QuizPage.vue]"]
  node_quiz_controller["Quiz and questions<br/>[lms_quiz.py]"]
  node_question_controller["Question records<br/>[lms_question.py]"]
  node_certificate["Certificates<br/>[lms_certificate.py]"]
  node_certificate_eval["Certificate evaluation"]
end

subgraph group_platform["Backend services"]
  node_course_api["LMS API<br/>[api.py]"]
  node_permissions["Access control<br/>[permissions.py]"]
  node_payment["Payment records<br/>[lms_payment.py]"]
end

node_learner(("Learner or instructor"))
node_platform_db[("Frappe data store")]
node_zoom["Zoom services"]

node_learner -->|"uses"| node_app
node_app -->|"renders routes"| node_routes
node_routes -->|"routes to"| node_course_pages
node_learner -->|"authors courses"| node_course_pages
node_course_pages -.->|"requests course operations"| node_course_api
node_course_api -->|"uses lesson logic"| node_course_lesson
node_course_api -->|"uses import export"| node_course_import
node_learner -->|"takes lessons"| node_lesson_page
node_lesson_page -.->|"requests lesson data"| node_course_api
node_learner -->|"joins batches"| node_batch_pages
node_batch_pages -.->|"requests batch operations"| node_course_api
node_course_api -->|"uses enrollment helpers"| node_bulk_enroll
node_batch_enrollment -->|"creates course enrollment"| node_enrollment
node_batch_controller -->|"supplies batch context"| node_live_class
node_learner -->|"takes quizzes"| node_quiz_pages
node_quiz_pages -.->|"requests assessment operations"| node_course_api
node_course_api -->|"uses quiz logic"| node_quiz_controller
node_course_api -->|"uses question logic"| node_question_controller
node_learner -->|"receives certificate"| node_certificate
node_course_api -->|"uses certificate logic"| node_certificate
node_course_api -->|"uses evaluation logic"| node_certificate_eval
node_course_api -->|"checks permissions"| node_permissions
node_enrollment -->|"checks paid enrollment"| node_payment
node_batch_enrollment -->|"references live classes"| node_live_class
node_review -->|"checks enrollment and reviews"| node_platform_db
node_live_class -.->|"creates Zoom classes"| node_zoom
node_course_api -.->|"reads and writes records"| node_platform_db

click node_app "https://github.com/frappe/lms/blob/develop/frontend/src/App.vue"
click node_routes "https://github.com/frappe/lms/blob/develop/frontend/src/routes.js"
click node_course_pages "https://github.com/frappe/lms/tree/develop/frontend/src/pages/Courses"
click node_lesson_page "https://github.com/frappe/lms/blob/develop/frontend/src/pages/Lesson.vue"
click node_course_lesson "https://github.com/frappe/lms/blob/develop/lms/lms/doctype/course_lesson/course_lesson.py"
click node_course_api "https://github.com/frappe/lms/blob/develop/lms/lms/api.py"
click node_course_import "https://github.com/frappe/lms/blob/develop/lms/lms/course_import_export.py"
click node_batch_pages "https://github.com/frappe/lms/tree/develop/frontend/src/pages/Batches"
click node_batch_controller "https://github.com/frappe/lms/blob/develop/lms/lms/doctype/lms_batch/lms_batch.py"
click node_bulk_enroll "https://github.com/frappe/lms/blob/develop/lms/lms/bulk_enrollment.py"
click node_enrollment "https://github.com/frappe/lms/blob/develop/lms/lms/doctype/lms_enrollment/lms_enrollment.py"
click node_batch_enrollment "https://github.com/frappe/lms/blob/develop/lms/lms/doctype/lms_batch_enrollment/lms_batch_enrollment.py"
click node_live_class "https://github.com/frappe/lms/blob/develop/lms/lms/doctype/lms_live_class/lms_live_class.py"
click node_quiz_pages "https://github.com/frappe/lms/blob/develop/frontend/src/pages/QuizPage.vue"
click node_quiz_controller "https://github.com/frappe/lms/blob/develop/lms/lms/doctype/lms_quiz/lms_quiz.py"
click node_question_controller "https://github.com/frappe/lms/blob/develop/lms/lms/doctype/lms_question/lms_question.py"
click node_certificate "https://github.com/frappe/lms/blob/develop/lms/lms/doctype/lms_certificate/lms_certificate.py"
click node_certificate_eval "https://github.com/frappe/lms/blob/develop/lms/lms/doctype/lms_certificate_evaluation/lms_certificate_evaluation.py"
click node_permissions "https://github.com/frappe/lms/blob/develop/lms/lms/permissions.py"
click node_review "https://github.com/frappe/lms/blob/develop/lms/lms/doctype/lms_course_review/lms_course_review.py"
click node_payment "https://github.com/frappe/lms/blob/develop/lms/lms/doctype/lms_payment/lms_payment.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_app,node_routes,node_course_pages,node_lesson_page,node_review toneBlue
class node_course_lesson,node_course_import,node_platform_db toneAmber
class node_batch_pages,node_batch_controller,node_bulk_enroll,node_enrollment,node_batch_enrollment,node_live_class toneMint
class node_quiz_pages,node_quiz_controller,node_question_controller,node_certificate,node_certificate_eval toneRose
class node_course_api,node_permissions,node_payment,node_learner,node_zoom toneIndigo
```

## Components

### Learning experience

- [Frontend app](https://github.com/frappe/lms/blob/develop/frontend/src/App.vue): `frontend/src/App.vue`
- [Page routing](https://github.com/frappe/lms/blob/develop/frontend/src/routes.js): `frontend/src/routes.js`
- [Course pages](https://github.com/frappe/lms/tree/develop/frontend/src/pages/Courses): `frontend/src/pages/Courses`
- [Lesson experience](https://github.com/frappe/lms/blob/develop/frontend/src/pages/Lesson.vue): `frontend/src/pages/Lesson.vue`
- [Course reviews](https://github.com/frappe/lms/blob/develop/lms/lms/doctype/lms_course_review/lms_course_review.py): `lms/lms/doctype/lms_course_review/lms_course_review.py`

### Course authoring

- [Lesson controller](https://github.com/frappe/lms/blob/develop/lms/lms/doctype/course_lesson/course_lesson.py): `lms/lms/doctype/course_lesson/course_lesson.py`
- [Course import export](https://github.com/frappe/lms/blob/develop/lms/lms/course_import_export.py): `lms/lms/course_import_export.py`

### Enrollment and delivery

- [Batch pages](https://github.com/frappe/lms/tree/develop/frontend/src/pages/Batches): `frontend/src/pages/Batches`
- [Batch management](https://github.com/frappe/lms/blob/develop/lms/lms/doctype/lms_batch/lms_batch.py): `lms/lms/doctype/lms_batch/lms_batch.py`
- [Bulk enrollment](https://github.com/frappe/lms/blob/develop/lms/lms/bulk_enrollment.py): `lms/lms/bulk_enrollment.py`
- [Course enrollment](https://github.com/frappe/lms/blob/develop/lms/lms/doctype/lms_enrollment/lms_enrollment.py): `lms/lms/doctype/lms_enrollment/lms_enrollment.py`
- [Batch enrollment](https://github.com/frappe/lms/blob/develop/lms/lms/doctype/lms_batch_enrollment/lms_batch_enrollment.py): `lms/lms/doctype/lms_batch_enrollment/lms_batch_enrollment.py`
- [Live classes](https://github.com/frappe/lms/blob/develop/lms/lms/doctype/lms_live_class/lms_live_class.py): `lms/lms/doctype/lms_live_class/lms_live_class.py`

### Assessment and credentials

- [Quiz experience](https://github.com/frappe/lms/blob/develop/frontend/src/pages/QuizPage.vue): `frontend/src/pages/QuizPage.vue`
- [Quiz and questions](https://github.com/frappe/lms/blob/develop/lms/lms/doctype/lms_quiz/lms_quiz.py): `lms/lms/doctype/lms_quiz/lms_quiz.py`
- [Question records](https://github.com/frappe/lms/blob/develop/lms/lms/doctype/lms_question/lms_question.py): `lms/lms/doctype/lms_question/lms_question.py`
- [Certificates](https://github.com/frappe/lms/blob/develop/lms/lms/doctype/lms_certificate/lms_certificate.py): `lms/lms/doctype/lms_certificate/lms_certificate.py`
- [Certificate evaluation](https://github.com/frappe/lms/blob/develop/lms/lms/doctype/lms_certificate_evaluation/lms_certificate_evaluation.py): `lms/lms/doctype/lms_certificate_evaluation/lms_certificate_evaluation.py`

### Backend services

- [LMS API](https://github.com/frappe/lms/blob/develop/lms/lms/api.py): `lms/lms/api.py`
- [Access control](https://github.com/frappe/lms/blob/develop/lms/lms/permissions.py): `lms/lms/permissions.py`
- [Payment records](https://github.com/frappe/lms/blob/develop/lms/lms/doctype/lms_payment/lms_payment.py): `lms/lms/doctype/lms_payment/lms_payment.py`

### Other components

- **Learner or instructor**
- **Frappe data store**
- **Zoom services**

## Connections

- Learner or instructor → Frontend app: uses (evidence: `README.md`)
- Frontend app → Page routing: renders routes (evidence: `frontend/src/App.vue`)
- Page routing → Course pages: routes to (evidence: `frontend/src/routes.js`)
- Learner or instructor → Course pages: authors courses (evidence: `README.md`)
- Course pages → LMS API: requests course operations
- LMS API → Lesson controller: uses lesson logic (evidence: `lms/lms/api.py`)
- LMS API → Course import export: uses import export (evidence: `lms/lms/api.py`)
- Learner or instructor → Lesson experience: takes lessons (evidence: `README.md`)
- Lesson experience → LMS API: requests lesson data
- Learner or instructor → Batch pages: joins batches (evidence: `README.md`)
- Batch pages → LMS API: requests batch operations
- LMS API → Bulk enrollment: uses enrollment helpers (evidence: `lms/lms/api.py`)
- Batch enrollment → Course enrollment: creates course enrollment (evidence: `lms/lms/doctype/lms_batch_enrollment/lms_batch_enrollment.py`)
- Batch management → Live classes: supplies batch context (evidence: `lms/lms/doctype/lms_live_class/lms_live_class.py`)
- Learner or instructor → Quiz experience: takes quizzes (evidence: `README.md`)
- Quiz experience → LMS API: requests assessment operations
- LMS API → Quiz and questions: uses quiz logic (evidence: `lms/lms/api.py`)
- LMS API → Question records: uses question logic (evidence: `lms/lms/api.py`)
- Learner or instructor → Certificates: receives certificate (evidence: `README.md`)
- LMS API → Certificates: uses certificate logic (evidence: `lms/lms/api.py`)
- LMS API → Certificate evaluation: uses evaluation logic (evidence: `lms/lms/api.py`)
- LMS API → Access control: checks permissions (evidence: `lms/lms/api.py`)
- Course enrollment → Payment records: checks paid enrollment (evidence: `lms/lms/doctype/lms_enrollment/lms_enrollment.py`)
- Batch enrollment → Live classes: references live classes (evidence: `lms/lms/doctype/lms_batch_enrollment/lms_batch_enrollment.py`)
- Course reviews → Frappe data store: checks enrollment and reviews (evidence: `lms/lms/doctype/lms_course_review/lms_course_review.py`)
- Live classes → Zoom services: creates Zoom classes (evidence: `README.md`)
- LMS API → Frappe data store: reads and writes records
