How markusproject/markus works
Main Components
a. Client-Side Layer:
• React components (in app/javascript/Components/)
• JavaScript assets (in app/assets/javascripts/)
• Stylesheets (in app/assets/stylesheets/)
b. Server-Side Layer:
• Rails application (MVC architecture)
• API controllers (in app/controllers/api/)
• WebSocket channels (in app/channels/)
• Background jobs (in app/jobs/)
c. Data Storage Layer:
• PostgreSQL database (indicated by database.yml.postgresql)
• Git repositories for student submissions
• File storage for uploads
d. External Services:
• LTI integration (Learning Tools Interoperability)
• Autotest system
• PDF processing system
Architecture Patterns to Highlight
a. Core Application Structure:
[Client Browser] <--> [Nginx/Apache] <--> [Rails App Server]
• [Background Jobs] <--> [Redis]
• [PostgreSQL] <--> [Git Storage]
b. Key Interactions:
• Grading workflow
• Authentication paths
• Real-time updates via WebSocket
Specific Implementation Details
a. Authentication & Authorization:
• Policy layer (app/policies/)
• LTI authentication flow
• Role-based access control
b. File Processing:
• Git repository management
• PDF annotation system
• Jupyter notebook handling
c. Assessment Workflow:
• Assignment submission
• Automated testing
• Manual grading
• Feedback delivery
Important Subsystems
a. Annotation System:
• Text annotations
• PDF annotations
• Image annotations
• HTML annotations
b. Testing Framework:
• Test runners
• Result processing
• Feedback generation
c. Management:
• Formation
• Member management
• Permission handling
Integration Points
a. External Tools:
• LTI integration
• Git interfaces
• Automated testing services
b. Internal Services:
• Background job processing
• WebSocket communication
• File storage management