Data

Tools

Indexes

Applications

Experiments

Open Source Science

poc_cleanarch_spring_multimodule

Clean Architecture with SpringBoot and Maven MultiModule

https://github.com/brunotacca/poc_cleanarch_spring_multimodule

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (4.2%) to scientific vocabulary

Keywords

assertj clean-architecture clean-code docker docker-compose github-actions java junit5 maven maven-multimodule reactor sonarqube spring springboot test test-containers webflux
Last synced: 4 months ago · JSON representation ·

Repository

Clean Architecture with SpringBoot and Maven MultiModule

Basic Info
  • Host: GitHub
  • Owner: brunotacca
  • License: mit
  • Language: Java
  • Default Branch: main
  • Homepage:
  • Size: 2.41 MB
Statistics
  • Stars: 12
  • Watchers: 0
  • Forks: 5
  • Open Issues: 3
  • Releases: 0
Topics
assertj clean-architecture clean-code docker docker-compose github-actions java junit5 maven maven-multimodule reactor sonarqube spring springboot test test-containers webflux
Created over 3 years ago · Last pushed about 3 years ago
Metadata Files
Readme Changelog Contributing Funding License Code of conduct Citation Codeowners Support

README.md

Clean Architecture + SpringBoot + MultiModule

SpringBoot project structured with Clean Architecture enforced by Maven MultiModule with whipped cream (Automated Tests) and a cherry added on top (Code Quality Analysis).

License: MIT

Sonar

[![Quality gate](https://sonarcloud.io/api/project_badges/quality_gate?project=brunotacca_poc_cleanarch_spring_multimodule)](https://sonarcloud.io/summary/new_code?id=brunotacca_poc_cleanarch_spring_multimodule) \ [![Sonar Analysis](https://github.com/brunotacca/poc_cleanarch_spring_multimodule/actions/workflows/sonar.yml/badge.svg)](https://github.com/brunotacca/poc_cleanarch_spring_multimodule/actions/workflows/sonar.yml)

Security Rating Maintainability Rating Reliability Rating \ Vulnerabilities Bugs Code Smells Technical Debt \ Lines of Code Coverage Duplicated Lines (%)

Proof of Concept:

Simple application (domain complexity) with hard architectural boundaries enforced by maven multimodule following Clean Architectural guidelines using Spring to make DI easy. In this CA, Spring framework is decoupled and required only in the external layers (api and datasources).

  • [x] Spring (easy DI setup (Spring IoC))
  • [x] SpringBoot (Quick Spring project setup)
  • [x] Maven MultiModule (Enforced Architectural Boundaries)
  • [x] Clean Architecture

Extras 1: This project features automated tests to demonstrate a way to do so in a clean architecture style with enforced boundaries. Since this is not a real-world application, the test suit doesn't go further than integration and unit tests.

  • [x] JUnit, Mockito and AssertJ
  • [x] Flyway
  • [x] H2 and Postgres
  • [x] Test Containers

Extras 2: This project also features automated code quality analysis by using:

  • [x] SonarQube
  • [x] GitHub Actions

Extras 3: RESTful API with Docs.

  • [x] RESTful API (HATEOAS)
  • [x] Documentation (Spring RestDocs + AsciiDoc + Pandoc & GitHub Actions)

Extras 4: Domain-Driven Design. Just a little bit to model this small project domain, even tho DDD is not recommended for small projects. This project stays just at the tip of the DDD iceberg. Check out the Project Domain.

  • [x] Domain PoC Planning

Documents

Project Progress

  • [x] Customer
    • [x] Domain
    • [x] Entities
    • [x] UseCases
    • [x] Adapters
    • [x] Controllers
    • [x] External
    • [x] Datasources
    • [x] Apis
  • [ ] Product
  • [ ] Order

Owner

  • Name: Tacca
  • Login: brunotacca
  • Kind: user
  • Location: Brazil
  • Company: UNESP

Thirst for knowledge.

Citation (CITATION.cff) 

cff-version: 1.2.0
message: "If you use this code, please cite it as below."
authors:
- family-names: "Oliveira"
  given-names: "Bruno Vitorelli Tacca"
  orcid: "https://orcid.org/0000-0002-2996-8360"
title: "POC SpringBoot CleanArchitecture with Maven Multimodule"
url: "https://github.com/brunotacca/poc_cleanarch_spring_multimodule"
year: 2022
version: 0.0.0-WIP
preferred-citation:
  type: software
  authors:
  - family-names: "Oliveira"
    given-names: "Bruno Vitorelli Tacca"
    orcid: "https://orcid.org/0000-0002-2996-8360"
  title: "POC SpringBoot CleanArchitecture with Maven Multimodule"
  url: "https://github.com/brunotacca/poc_cleanarch_spring_multimodule"
  year: 2022
  version: 0.0.0-WIP

GitHub Events

Total
  • Watch event: 1
  • Fork event: 2
Last Year
  • Watch event: 1
  • Fork event: 2

Committers

Last synced: almost 2 years ago

All Time
  • Total Commits: 97
  • Total Committers: 2
  • Avg Commits per committer: 48.5
  • Development Distribution Score (DDS): 0.031
Past Year
  • Commits: 7
  • Committers: 2
  • Avg Commits per committer: 3.5
  • Development Distribution Score (DDS): 0.143
Top Committers
Name Email Commits
Bruno Tacca b****a@g****m 94
brunotacca b****a 3

Issues and Pull Requests

Last synced: almost 2 years ago

All Time
  • Total issues: 4
  • Total pull requests: 6
  • Average time to close issues: about 1 month
  • Average time to close pull requests: 10 days
  • Total issue authors: 1
  • Total pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.83
  • Merged pull requests: 5
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • brunotacca (4)
Pull Request Authors
  • brunotacca (6)
Top Labels
Issue Labels
Pull Request Labels

Dependencies

ca-spring-multimodule/adapter/controllers/pom.xml maven
  • com.brunotacca.caspringmultimodule:domain-usecases 0.0.1-SNAPSHOT
ca-spring-multimodule/domain/entities/pom.xml maven
  • org.assertj:assertj-core
  • org.mockito:mockito-core
  • org.projectlombok:lombok
  • org.junit.jupiter:junit-jupiter test
ca-spring-multimodule/domain/usecases/pom.xml maven
  • com.brunotacca.caspringmultimodule:domain-entities 0.0.1-SNAPSHOT
  • org.assertj:assertj-core
  • org.mockito:mockito-core
  • org.projectlombok:lombok
  • org.junit.jupiter:junit-jupiter test
ca-spring-multimodule/external/apis/pom.xml maven
  • com.brunotacca.caspringmultimodule:adapter-controllers 0.0.1-SNAPSHOT
  • org.springframework.boot:spring-boot-starter-webflux
ca-spring-multimodule/pom.xml maven
  • org.springframework.boot:spring-boot-devtools 2.7.2
  • org.springframework.boot:spring-boot-starter 2.7.2
  • org.springframework.boot:spring-boot-starter-test 2.7.2 test
ca-spring-multimodule/report-aggregate/pom.xml maven
  • com.brunotacca.caspringmultimodule:domain-entities 0.0.1-SNAPSHOT
  • com.brunotacca.caspringmultimodule:domain-usecases 0.0.1-SNAPSHOT
.github/workflows/extra-docs.yml actions
  • actions/checkout v3 composite
  • docker://pandoc/core 2.19 composite
  • stefanzweifel/git-auto-commit-action v4 composite
.github/workflows/sonar.yml actions
  • actions/cache v3 composite
  • actions/checkout v3 composite
  • actions/setup-java v3 composite
ca-spring-multimodule/docker-compose.yml docker
  • dpage/pgadmin4 latest
  • postgres latest
ca-spring-multimodule/external/datasources/pom.xml maven
  • org.testcontainers:testcontainers-bom 1.17.3 import
  • com.brunotacca.caspringmultimodule:domain-usecases 0.0.1-SNAPSHOT
  • com.vladmihalcea:hibernate-types-55 2.19.0
  • org.flywaydb:flyway-core
  • org.postgresql:postgresql
  • org.springframework.boot:spring-boot-starter
  • org.springframework.boot:spring-boot-starter-actuator
  • org.springframework.boot:spring-boot-starter-data-jdbc
  • org.springframework.boot:spring-boot-starter-data-jpa
  • com.brunotacca.caspringmultimodule:domain-entities 0.0.1-SNAPSHOT test
  • org.springframework.boot:spring-boot-starter-test test
  • org.testcontainers:junit-jupiter test
  • org.testcontainers:postgresql test
  • org.testcontainers:testcontainers test