How mahiyat/academia-task-management works
Main Components
• Frontend (Client): Located in the “client” directory, this React application provides the web-based interface. It includes multiple components (e.g., TeacherDashboard, KanbanBoard, ReportGeneration, etc.) and is Dockerized, as indicated by its Dockerfile and package.json.
• Backend (Server): Found in the “server” directory, the Node.js server is structured using an MVC-like layering approach. It houses routes, controllers, services, and models. It is also Dockerized and includes testing, JSDoc documentation, and configuration files.
• Database: The README specifies MongoDB for data storage, with environment variables set up for connecting to a MongoDB instance.
• AI Service (Ollama): This external service is invoked by the backend for AI-driven responses. Environment variables and Docker Compose configuration (including GPU support) are included.
• Infrastructure & Deployment: Docker Compose files (docker-compose.yml and docker-compose-ollama-gpu.yml) indicate that the system’s services are containerized, and CI/CD workflows (GitHub Actions in the .github/workflows folder) are in place.
• Documentation and Testing: The project includes directories for tests and documentation (via JSDoc), providing additional layers to the design.
Relationships and Interactions
• The server, acting as the central orchestrator, communicates asynchronously with MongoDB for CRUD operations and with the Ollama AI service for generating AI responses.
• Within the server, illustrate the internal flow: requests hit the API routes, are handled by controllers, have business logic encapsulated in services, and interact with the models for database operations.
• Docker is used to encapsulate the client, server, and possibly the Ollama service. This indicates a microservice-like deployment even if the services are part of the same project.
Architectural Patterns/Design Principles
• Use of the MVC pattern on the server side (Routes → Controllers → Services → Models).
• Separation of concerns between frontend and backend.
• Deployment using Docker Compose signifies a containerized microservice approach.
• Clear environment variable configuration allows the system to be flexible (for example, switching between local MongoDB and cloud-based services or adjusting the Ollama service endpoint).
Relevant Technologies
• Client: React.js, Yarn/npm, Docker.
• Server: Node.js, Express (implied from controllers/routes), possibly Babel (given the .babelrc), testing frameworks (e.g., Jest or similar for unit tests), and Docker.
• Database: MongoDB (with the connection string provided via environment variables).
• External AI: Ollama AI model, integrated via a REST endpoint.
• CI/CD and Documentation: GitHub Actions for CI, JSDoc for documentation.