How guillermoscript/lms works
Project type and purpose
• This is a backend‐focused, full LMS application built on Payload CMS (Node.js + TypeScript) with an auto-generated admin UI and REST/GraphQL APIs for end users.
• Its main features include course/lesson management, subscriptions and orders, payments, evaluations, reviews, notifications, and scheduled tasks (cron jobs).
File structure
• Top-level files: Dockerfile, docker-compose.yml, .env, Travis CI config, Postman collections—indicate containerization, CI, and API testing.
• src/server.ts: Application entry point (Express + Payload).
• src/collections: Domain models (Courses, Lessons, Users, Orders, Subscriptions, etc.). Each “collection” maps to a MongoDB collection with hooks (e.g., send email, enforce roles).
• src/access: Access control rules (isAdmin, isLoggedIn, isEnrolledOrHasAccess, etc.).
• src/services: Business logic modules (openAi integration, scoring, email notifications).
• src/lib/cron.ts: Schedules daily checks on subscriptions.
• src/templates: Email templates for notifications.
• src/seed: Data-seeding scripts for initial data.
README for additional insights
• Confirms tech stack: Node.js 14.x, Yarn 1.x, MongoDB 4.x, Docker support.
• Lists core features and flows (course creation/enrollment, subscription lifecycle, payment flow, evaluations).
• Mentions ext. env vars: MONGODB_URI, PAYLOAD_SECRET, PAYLOAD_CONFIG_PATH.
Main components and relationships
a. User Interfaces
• Admin UI (served by Payload CMS) for managing courses, plans, products, etc.
• End-user Web UI or mobile client (consumes REST/GraphQL APIs).
b. Backend Application
• Node.js + Express + Payload CMS
• Authentication & Authorization (passport, src/access rules)
• Business logic services (src/services)
• Cron scheduler (src/lib/cron.ts)
c. Data Storage
• MongoDB (collections correspond to payload collections)
d. External Services
• Payment gateways (Zelle, Pago Móvil, generic payment methods)
• Email service (SMTP or 3rd-party) for notifications
• OpenAI API (for any AI-driven features)
Architectural patterns and design principles
• Payload CMS enforces a form of MVC: Collections = models, hooks = controllers, admin UI = views.
• Separation of concerns: access control in src/access, domain logic in src/services, data models in src/collections, scheduling in src/lib/cron.
• Event-driven hooks trigger side effects (email notifications, order post-processing).
• Containerization via Docker for consistent environments.