How arukoufx/classroom-gestor works
Main Components
• Frontend (aula-frontend):
– Built with React (v18) and optionally TypeScript.
– Uses Axios for API communication and React Router for navigation.
– Contains UI components (e.g., CursoList, ProfesorList, CategoriaForm) and static resources (public folder with index.html, etc.).
• Backend (aula-backend):
– Developed with Java 17 and Spring Boot 3, following an MVC pattern.
– Key packages include controllers (web endpoints for courses, professors, and categories), services (business logic), repositories (Spring Data JPA for data persistence), models (domain objects), and dtos (data transfer objects).
– Uses additional configurations and template resources for server-side rendered HTML pages (using Thymeleaf or similar).
• Database:
– MySQL 8, which stores course, professor, and category data.
• External / Optional Components:
– Potential JWT authentication or other external services like email or logging (as noted in the roadmap for authentication).
Relationships and Data Flow
• Within the Backend, illustrate the flow:
• Controllers receive HTTP requests and call Service layer methods.
• Services implement business logic and interact with the Repository layer.
• Repositories communicate with the MySQL database.
• Optionally, include feedback loops where the backend sends HTML pages (from the templates folders) if server-side rendering is applicable.
Architectural Patterns and Design Principles
• MVC Pattern in the Backend:
– Controllers, Services, Models, and Repositories clearly segregated.
• Full-stack Separation:
– Emphasize the distinct responsibilities of the frontend and backend systems, with a clear API contract (use of Axios in frontend to call backend endpoints).
• Modularity and Clear Layered Architecture:
– Break down each component (frontend modules, back-end modules, database) and show their responsibilities and how they interact.
Relevant Technologies and Frameworks
• Backend: Java 17, Spring Boot 3 (including modules such as Spring Data JPA and Spring Web), Maven for dependency and build management, Lombok, and ModelMapper.
• Frontend: React 18, Axios, React Router, and styling frameworks (TailwindCSS or Material UI as commented in README).
• Database: MySQL 8.
Additional Details
• Important infrastructure details like configuration files (e.g., application.properties for database settings) and build tools (Maven for backend, npm for frontend).
• Front-end and back-end parts are clearly separated but demonstrate their integration through the API layer.