How frappe/lms works
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: api.py LMS API · Courses Course pages · lms_live_class.py Live classes · lms_batch_enrollment.py Batch enrollment
Components 24
Learning experience
- Frontend app
frontend/src/App.vue - Page routing
frontend/src/routes.js - Course pages
frontend/src/pages/Courses - Lesson experience
frontend/src/pages/Lesson.vue - Course reviews
lms/lms/doctype/lms_course_review/lms_course_review.py
Course authoring
- Lesson controller
lms/lms/doctype/course_lesson/course_lesson.py - Course import export
lms/lms/course_import_export.py
Enrollment and delivery
- Batch pages
frontend/src/pages/Batches - Batch management
lms/lms/doctype/lms_batch/lms_batch.py - Bulk enrollment
lms/lms/bulk_enrollment.py - Course enrollment
lms/lms/doctype/lms_enrollment/lms_enrollment.py - Batch enrollment
lms/lms/doctype/lms_batch_enrollment/lms_batch_enrollment.py - Live classes
lms/lms/doctype/lms_live_class/lms_live_class.py
Assessment and credentials
- Quiz experience
frontend/src/pages/QuizPage.vue - Quiz and questions
lms/lms/doctype/lms_quiz/lms_quiz.py - Question records
lms/lms/doctype/lms_question/lms_question.py - Certificates
lms/lms/doctype/lms_certificate/lms_certificate.py - Certificate evaluation
lms/lms/doctype/lms_certificate_evaluation/lms_certificate_evaluation.py
Backend services
- LMS API
lms/lms/api.py - Access control
lms/lms/permissions.py - Payment records
lms/lms/doctype/lms_payment/lms_payment.py
Other components
- Learner or instructor
- Frappe data store
- Zoom services
Connections 27
- Learner or instructor → Frontend app: uses
README.md - Frontend app → Page routing: renders routes
frontend/src/App.vue - Page routing → Course pages: routes to
frontend/src/routes.js - Learner or instructor → Course pages: authors courses
README.md - Course pages → LMS API: requests course operations
- LMS API → Lesson controller: uses lesson logic
lms/lms/api.py - LMS API → Course import export: uses import export
lms/lms/api.py - Learner or instructor → Lesson experience: takes lessons
README.md - Lesson experience → LMS API: requests lesson data
- Learner or instructor → Batch pages: joins batches
README.md - Batch pages → LMS API: requests batch operations
- LMS API → Bulk enrollment: uses enrollment helpers
lms/lms/api.py - Batch enrollment → Course enrollment: creates course enrollment
lms/lms/doctype/lms_batch_enrollment/lms_batch_enrollment.py - Batch management → Live classes: supplies batch context
lms/lms/doctype/lms_live_class/lms_live_class.py - Learner or instructor → Quiz experience: takes quizzes
README.md - Quiz experience → LMS API: requests assessment operations
- LMS API → Quiz and questions: uses quiz logic
lms/lms/api.py - LMS API → Question records: uses question logic
lms/lms/api.py - Learner or instructor → Certificates: receives certificate
README.md - LMS API → Certificates: uses certificate logic
lms/lms/api.py - LMS API → Certificate evaluation: uses evaluation logic
lms/lms/api.py - LMS API → Access control: checks permissions
lms/lms/api.py - Course enrollment → Payment records: checks paid enrollment
lms/lms/doctype/lms_enrollment/lms_enrollment.py - Batch enrollment → Live classes: references live classes
lms/lms/doctype/lms_batch_enrollment/lms_batch_enrollment.py - Course reviews → Frappe data store: checks enrollment and reviews
lms/lms/doctype/lms_course_review/lms_course_review.py - Live classes → Zoom services: creates Zoom classes
README.md - LMS API → Frappe data store: reads and writes records