How hdbv95/task-management-system works
Main Components
• Frontend Client: Represent the React application (frontend/tasks-app). Note that it handles display, JWT auto-refresh, and interacts with the backend API using REST calls (GET, POST, PATCH, DELETE).
• Backend API: Represent the Django project (backend/task_manager). Break it down into its main apps or modules (e.g., “tasks” and “users”). Show that it uses Django REST Framework for exposing the API endpoints and JWT for authentication. Include the swagger & ReDoc documentation endpoints.
• Database: Clearly indicate the SQLite database that the backend uses. Also, mention the initial fixture (db_fixture.json) that is used to set up the database.
• Containerization: Represent Docker and Docker Compose. Show that both the frontend and backend have their Dockerfiles and are orchestrated using docker-compose. This helps emphasize that the entire system is containerized.
Relationships and Interactions
• If desired, include a component for unit testing (mentions of pytest for backend) to note that testing is a core aspect of the development process, though this might not need to be highlighted in the high-level architecture.
Architectural Patterns and Design Principles
• That the backend follows an MVT (Model-View-Template) / RESTful architecture pattern – highlight that the “tasks” and “users” apps separate concerns (models, serializers, views, etc.).
• Separation of concerns between the frontend and backend. The frontend is built with modern technologies (React/Vite/TypeScript) and acts as the consumer of the API.
Technology Stack
• Specify Django, Django REST Framework, and JWT for the backend.
• Specify React, Vite, and TypeScript for the frontend.
• Docker is pivotal for containerization; include Docker Compose for orchestrating multi-container setup.
• SQLite as the database system.
• Additionally, mention pre-commit hooks and tools like black, flake8, and mypy used for ensuring code quality.