How syu607/dems works
Project Type & Purpose
• This is a Django-based full-stack application.
• Its purpose is to manage events – from registration and event creation to assessment processing and certificate generation.
• Key features include role-based authentication (users and admins), event management, dashboard analytics, and an AI grading component.
File Structure
• The main Django project files are in the “dems” directory (settings, URL routing, ASGI/WGI configurations).
• There are two primary apps:
• The “events” app: Contains models, views, templates, migrations, and utilities responsible for event management, assessments (including an AI assessment module), dashboards, and certificate handling.
• The “users” app: Manages user authentication, registration, role-based dashboards (like principal, coordinator, HOD, and student), and related templates and forms.
• Other important directories/files:
• “static” – contains images used by the front-end.
• “templates” within each app – provides the user interface.
• Configuration files (.env.example, requirements.txt, and GitHub workflows) – essential for deployment and CI/CD.
a. Main Components to Include:
• Web Server/Backend Layer: Represented by the “dems” project that ties everything together (configurations, URL routing, and WSGI/ASGI).
• Applications (Microservices/Modules):
• Events module (event creation, registration, AI assessment, analytics).
• Users module (user management and dashboards).
• Database Layer: Implied by the Django migrations (for storing event data, user data, assessments, and certificates).
• Frontend Layer:
• Django Templates under both “events” and “users”.
• Static resources (images, CSS, JS if applicable).
• External Services/Integrations:
• AI-assisted grading implemented in events/ai_assessment.py (could be showcased as an external service or internal component depending on deployment).
• Deployment infrastructure (GitHub Actions workflows).
b. Relationships and Interactions:
• The browser/user interacts with the frontend (templates served by Django) which then communicates with the Django views.
• Views interact with models to query/update the database.
• The Django URL routing ties user requests and application logic together.
• The AI grading component (within events) is an auxiliary process that interacts with assessment submission data.
• Dashboard interfaces in both “events” and “users” provide role-based data views.
• The admin interface (present in both apps) allows management and oversight of events/users.
c. Architectural Patterns & Design Principles:
• Use the standard Django Model-View-Template (MVT) pattern.
• Separation of concerns: events and users are each separate apps, keeping the business logic modular.
• Role-based access control as part of the security architecture.
• CI/CD and deployment automation (noted in the GitHub workflow files).
• Configuration through environment variables (.env file).
d. Relevant Technologies & Frameworks:
• Django as the core web framework.
• Django MVT architecture.
• Database (e.g., PostgreSQL or another relational DB) implied by migration files.
• GitHub Actions for CI/CD as seen in .github/workflows.
• AI module for grading: events/ai_assessment.py indicates integration of some AI processing, which might leverage external libraries or microservice patterns.