How aalto-grades/aalto-grades works
Main System Components
a) Client Layer (Frontend)
• React-based web application
• Components for course management, grading, and user administration
• i18n support for multiple languages
• Material UI components (implied by the structure)
b) Server Layer (Backend)
• Node.js REST API server
• Authentication/Authorization system
• Database controllers and utilities
• Integration with external systems (A+ LMS)
c) Database Layer
• PostgreSQL database (implied by migrations and Sequelize usage)
• Models for courses, grades, users, and other entities
d) External Systems
• A+ Learning Management System integration
• SISU (grade export system)
Key Architectural Elements to Highlight
a) Frontend Architecture:
• Component-based structure with clear separation of concerns
• Context providers for auth, grades table, and graph management
• API hooks layer for data fetching
• Shared components and utilities
b) Backend Architecture:
• MVC-like pattern with controllers, routes, and models
• Middleware layer for auth, rate limiting, and error handling
• Swagger/OpenAPI documentation
• Database migrations and seeding system
Specific Implementation Details
Important features:
a) Authentication Flow:
• Multiple auth methods (local, external)
• MFA support
• Role-based access control
b) Grade Management:
• Course parts and tasks hierarchy
• Grade calculation system
• Import/export capabilities
• Reverse Proxy |
• ↓
• Client Layer | | Server Layer | | External Systems |
• (React + Material UI) | ←→ | (Node.js + REST) | ←→ | (A+ LMS, SISU) |
• ↕
• Database Layer |
• (PostgreSQL) |
Component Relationships
Key interactions:
• Client-Server communication via REST API
• Authentication flow between components
• Database operations and relationships
• External system integrations
• Grade calculation and processing flow
Additional Details
Elements:
• API endpoints grouping
• Security layers
• Data flow directions
• Caching mechanisms (if any)
• Error handling paths
• User role access paths
Technical Stack Callouts
Technologies:
• Frontend: React, TypeScript, Material UI, i18next
• Backend: Node.js, Express, Sequelize
• Testing: Jest, Playwright
• Infrastructure: Docker, Docker Compose
• Documentation: Swagger/OpenAPI
Remember to include notes about scalability considerations and potential future integration points, as this appears to be an actively developed system.