How merinjohnad/gitclass works
Project type and purpose
• Its apparent purpose is to coordinate and host course materials, exercises, and perhaps tooling for a Git‐based class.
Sketch out an expected system architecture
Since the project isn’t fleshed out, start by hypothesizing the likely components of a Git‐learning platform:
a. Frontend web application (served to students for tutorials, exercise interfaces).
b. Backend API service (handles authentication, content retrieval, exercise grading).
c. Git service integration (could be a self‐hosted GitLab/Gitea or GitHub).
d. Database (stores user profiles, progress, exercise metadata).
e. Continuous Integration / grading pipeline (automatically checks student repos for correctness).
f. Admin/Instructor portal (for uploading new exercises, reviewing student submissions).
g. External services (e.g., email service for notifications).
Relationships and data flows
• Student browser ↔ Frontend UI: HTTP/HTTPS requests, interactive coding exercises.
• Frontend UI ↔ Backend API: REST or GraphQL calls for login, fetching lessons, submitting answers.
• Backend API ↔ Database: SQL/NoSQL queries to store/retrieve user progress and metadata.
• Backend API ↔ Git service: API calls to create student repositories, monitor commits, trigger CI jobs.
• Git service ↔ CI pipeline: Webhooks or built‐in runners to run grading scripts whenever a student pushes code.
• Admin portal ↔ Backend API: Protected endpoints to manage content, view analytics.
Architectural patterns and design principles
• Separation of concerns: clear division between UI, business logic, data layer, Git operations.
• Microservices or modular services: the CI/grading service could be its own component.
• Event‐driven workflows: use webhooks/events from the Git service to trigger grading.
• Security layers: authentication (OAuth or JWT), role‐based access for students vs. instructors.
Steps to refine once code appears
• Ask the team to sketch out the feature set: what exercises, what grading logic, what authentication system.
• Expand the file tree with directories for each major component.