How chandrima0503/secureskyscholars works
Project type and purpose
• SecureSkyScholars is a full-stack web application built in Django.
• Purpose: Manage students, staff, courses, attendance, feedback, notifications and live classrooms.
• Key indicators:
• student_management_system (Django project)
• students_app (business logic, models, views, templates)
• MySQL configured in settings.py
• Static assets (AdminLTE, Chart.js, Socket.io, etc.)
File structure
• Top-level directories & files:
• student_management_system/ – Django project settings, URL routing, ASGI/WSGI.
• students_app/ – custom Django app: models, views (admin, staff, student), middleware, management commands, email backend.
• templates/ (under students_app) – separate areas for admin, staff, student pages; signup & registration.
• staticfiles/ & students_app/static/ – pre-collected and versioned frontend assets: AdminLTE theme, plugins, Socket.io client, charting libraries.
• Procfile – Heroku deployment.
• .github/workflows/django.yml – CI pipeline.
README for additional insights
• MySQL database as primary persistence.
• CI via GitHub Actions; automatic build & test.
• Deployment target: local dev server and Heroku (Procfile).
Main components
a. Clients (web browsers) with three personas: Admin, Staff, Student
b. Reverse proxy / Load balancer (Heroku router or Nginx)
c. Django Application Server (Gunicorn via WSGI/ASGI)
– Core: student_management_system + students_app
– Middleware: LoginCheckMiddleware, Django’s auth, email backend
d. Static Asset Store / CDN
– AdminLTE, JS/CSS, Socket.io client, charting libs, etc.
e. MySQL Database
– Schema generated by Django migrations (models in students_app/models.py)
f. External services
– SMTP Email Service (used by backend_email.py)
– (Optional) Real-time subsystem or video conferencing service (Socket.io)
g. CI/CD Pipeline
– GitHub Actions → run tests → deploy to Heroku
Relationships & data flows
• Browser → HTTP(S) → Load Balancer (Heroku) → Django Server
• Django Server
• Serves dynamic pages via template engine (templates/*.html)
• Serves or redirects static file requests to Asset Store/CDN
• Reads/writes data to MySQL via Django ORM
• Sends emails via SMTP backend
• (If implemented) opens WebSocket/Socket.io channel for live classroom interactions
• GitHub Actions commits → build & test → deploy to Heroku (automatic)
Architectural patterns & design principles
• MVC (Django’s MTV):
• Models layer in students_app/models.py
• Templates in students_app/templates/…
• Views in views.py, views_admin.py, views_staff.py, views_student.py
• Separation of concerns:
• Authentication & role-based pages (admin vs. staff vs. student)
• Static asset bundling vs. dynamic content
• Custom middleware for login checks
• Twelve-factor app ready:
• Procfile for process declaration
• Config in settings.py from environment
Detail & essential elements
• Major static plugins as one grouped “AdminLTE & JS Plugins” node.
• Database migrations via management command runmigrations.
• Environment variables (DB credentials) loaded in settings.py.