How grupo3-eoi/pawhome works
Main Components and Their Responsibilities
• Application Core Layer:
• Spring Boot application (the main entry point in Application.java) that orchestrates the entire flow.
• Clearly defined layers such as Controllers (handling REST endpoints and user interactions), Services (containing business logic), and Repositories (managing persistence operations).
• Data Transfer Objects (DTOs) and Entities that define the data models.
• Loader classes used for initializing data for different environments (e.g., AlejandroDataLoader, DesarrolloDataLoader, etc.).
• Configuration and Profile Management:
• Various properties files (application.properties, application-local.properties, application-desarrollo.properties, application-produccion.properties) that support Spring Profiles (default, dev, prod).
• SecurityConfig, which illustrates how security is configured in the application.
• Persistence and Database Components:
• Database layer with MySQL (aimed to be instantiated via Docker Compose). Indicate how the Docker Compose files (compose.yaml, compose-desarrollo.yaml, compose-produccion.yaml) and additional MySQL-specific Compose files contribute to setting up the local and specific environment databases.
• Testing Frameworks:
• Components for the testing strategy. Represent the integration tests (in src/test/java), unit tests, and especially the usage of TestContainers to create isolated containerized environments for integration testing.
• CI/CD and Quality Gate Integration:
• External services such as GitHub Actions for automated testing, build, and deployment.
• SonarQube as the tool used to analyze the code quality, documentation of metrics (quality gates, coverage, maintainability, etc.), and how it fits into the automated pipeline.
• Deployment Automation:
• Docker Compose configuration that automatically brings up the required services (notably MySQL) when running the application.
• IntelliJ IDEA “.run” profiles and how they mirror the deployment on remote environments (development and production).
Relationships and Interactions
• Data flow from the external client (which might be a web browser serving static HTML pages from the templates/static folders) to the Controllers.
• How Controllers call Services, which in turn use Repositories to interact with the database.
Architectural Patterns and Design Principles
• Layered approach (MVC-like) used to separate concerns within the code.
• Use of SOLID principles and DRY, as outlined in the README, to maintain low coupling and high cohesion.
• The Repository Pattern is of note here, as well as the use of DTOs for clean data transfer between layers.
• IoC (Inversion of Control) provided by Spring, which manages dependencies in the system.
Technologies, Frameworks, and Tools
• Also, note IntelliJ IDEA as the integrated development environment with prebuilt .run configurations that help manage local deployments.
• GitHub and its workflows for continuous integration/continuous deployment (with GitHub Actions YAML files).