KLEAN ARCH SAMPLE

Sample project with modules to represent a clean architecture. Using Kotlin and Gradle to build

IN DEVELOPMENT...

Technologies

• Language: Kotlin
• Compilation: Gradle
• Framework: Spring Boot
• Cache: Caffeine
• Banco de dados: H2 / MySQL / Flyway
• Documentation: Swagger
• Tests:
  • Test unit jUnit5
  • Mocks Mockk
  • Coverage Jacoco

Building and Running the application

• Building the application:

./gradlew clean build

• Tests

  • All tests:

      ./gradlew check
  

  • Unit tests:

      ./gradlew test
  

  • Integration tests ( marked with @Tag("integration") )

      ./gradlew integrationTest
  

  • To generate jacoco reports after test (output: build/reports/jacoco/jacocoFullReport)

      ./gradlew jacocoFullReport
  

• Running the application (from the jar, after having built it):

    java -jar build/klean-arch.jar

• Running the application (on the fly):

    ./gradlew bootRun

• Running the application (in the IDE): open and run the main class ( Configuration module )

    br.com.helpdev.kleanarch.Application

• More info on available tasks:

    ./gradlew tasks

Resources

• Clean Architecture - Robert C. Martin
• Clean Architecture presentation - Mattia Battiston
• clean-architecture-example - mattia-battiston (forked)