How trojandonut/scrumflow works
Main Components
• Frontend: Represented by the “frontend” directory. This part uses React and Redux (as seen from the store configuration and React components/pages) to provide the user interface.
• Backend: Located in the “backend” directory. It’s built with Django and organized into modular apps such as users, projects, sprints, stories, and tasks. Note that each of these apps follows its own MVC/MVT structure (models, views, serializers, and sometimes migrations).
• API: The communication layer exposed by the Django REST Framework. This layer serves as the connection between the frontend and backend.
• Database: While not explicitly named in files, the migrations and Django configuration indicate an underlying relational database (SQLite by default or PostgreSQL if configured otherwise).
• Docker & Deployment: Docker-related files (Dockerfile.backend, Dockerfile.frontend, docker-compose.yml, docker-start.sh) show that the app is containerized. This highlights an infrastructure layer with multiple containers handling different parts of the application.
Establish Relationships and Data Flow
• Frontend (React) sends HTTP requests (using REST APIs) to the backend.
• The backend (Django) processes these requests managing authentication (JWT, two-factor authentication), user, project, sprint, user story, and task management.
• The backend communicates with the database (via Django ORM) to store and retrieve data.
• Docker Compose orchestrates the deployment by starting and linking containerized services (frontend and backend).
Architectural Patterns and Design Principles
• Modular Design: The Django backend uses separate apps (users, projects, sprints, stories, tasks) for clear separation of responsibilities.
• Component-Based UI: The React frontend organizes code into components, pages, and redux slices, ensuring reusability and maintainability.
• Containerization: The Dockerfiles and docker-compose setup denote a micro-services style deployment, even if both containers currently run as single services.
• RESTful Communication: The system relies on standardized API contracts to handle the client-server interaction.
Final Checklist
• Clear labels for each major component, such as “React Frontend”, “Django Backend”, “Users Service”, “Projects Service”, “Sprints Service”, “Stories Service”, “Tasks Service”, and “Database”.
• Optionally, include annotations for Docker setup (Dockerfiles, docker-compose) and integration points like the API documentation endpoint.