How skycascade/skylearn works
Main Components
• Client Layer: This represents user interactions via browsers or mobile devices.
• Frontend/UI Layer: Represented by the templates folder (HTML files) and static assets (CSS, JS, fonts, images, SCSS).
• You may illustrate a “Presentation Layer” that handles rendering pages such as dashboards, login, registers, course pages, and quiz forms.
• Backend Layer: The bulk of the system exists within Django’s apps.
• Accounts – handles user registration, authentication, profiles, access control.
• Core – includes dashboard and general information (news, events, session and semester management).
• Course – covers course creation, allocation, registration, and program management.
• Quiz – manages quiz creation, question types (MCQ, true/false, essay), progress tracking, and results.
• Payments – processes payment gateway interactions and invoice generation.
• Result – manages assessment results, computing grades and summaries.
• Search – handles search functionality across different models.
• Config: Central configuration and routing is located in the “config” folder (settings, URL routing, ASGI/WGI entry-points).
• External Services / Infrastructure:
• Database (which is indirectly referenced via the migration files in each app—likely PostgreSQL/MySQL) where all persistent data is stored.
• Optionally denote integration points for external payment processors or third-party quiz support, as referenced in the README.
Architectural Patterns
• MVC (or MVT in Django parlance): Clearly note that the system uses:
• Models (in each app for business data), Views (Python functions/classes processing logic) and Templates (the presentation layer).
• Modular (Separation-of-Concerns): Each domain (accounts, course, quiz, etc.) is encapsulated within its own Django app making it easier to scale.
• Reusability: The presence of decorators, signals, and utility modules in several apps indicates adherence to DRY principles.
Relevant Technologies and Frameworks
• Django Web Framework – central for structuring the backend.
• Django ORM – handling data models and migrations.
• HTML/CSS/JavaScript – for the client-side functionality.
• Other integrations: payment processors (e.g., Stripe, PayPal, Coinbase as indicated by the different payment templates), PDF generation, and workflow automation (GitHub workflows for Django and Pylint).