How sivaprasadreddy/spring-boot-application-template works
Project Type and Purpose
• This is a monolithic, backend-only Spring Boot application template.
• It provides REST endpoints, persistence via Spring Data JPA/PostgreSQL, Flyway migrations, OpenAPI docs, test automation, CI/CD pipelines, and Docker deployment.
Main Architectural Components
a. Client / Consumer
• Any HTTP client (e.g., browser, Postman, another microservice) calling the REST API.
b. Spring Boot Application
• Web layer (Spring MVC controller package users/web/controller)
• Service layer (users/domain/UserService)
• Repository layer (users/domain/UserRepository, Spring Data JPA)
• Flyway migration (runs at startup, scripts under resources/db/migration)
• Springdoc OpenAPI (auto-generated API docs)
c. Database
• PostgreSQL instance (used in production via Docker Compose and in tests via Testcontainers)
• Flyway-managed schema migrations
d. CI/CD & Quality Gates
• GitHub Actions (Maven and Gradle workflows under .github/workflows/)
• SonarCloud scan (configured via sonar-project.properties)
• OWASP Dependency Check
• JaCoCo code coverage
e. Containerization & Deployment
• Cloud Native Buildpacks (Spring Boot Maven/Gradle plugin builds OCI image)
• Docker registry (push built image)
• Docker Compose setup (deployment/docker-compose/docker-compose.yml)
• Local dev/test containers (Testcontainers)
Relationships & Data Flows
1. Client → HTTP request → Spring MVC Controller (UserController)
2. Controller → invokes → UserService
3. Service → uses → UserRepository (Spring Data JPA)
4. Repository → executes SQL → PostgreSQL DB
5. On app startup → Flyway runs migrations against DB
6. Springdoc generates OpenAPI docs accessible at /v3/api-docs and Swagger UI
7. Git push → triggers GitHub Actions → runs build/format-test-coverage → Sonar scan → builds Docker image → publishes to registry
8. Docker Compose pulls application image + postgres image → starts two containers → binds ports (8080 → app, 5432 → db)
Architectural Patterns & Principles
• Layered Architecture: clear separation of concerns (Web → Service → Persistence).
• Domain-driven package structure: com.sivalabs.myapp.users.domain vs. users.web.
• 12-Factor Apps: externalize config in application.properties.
• Shift-left testing: Testcontainers for integration tests (see TestcontainersConfig.java).
• Infrastructure as Code: Docker Compose for local/dev deployment, Cloud Native Buildpacks for image creation.