Prerequisites

• Java 25 or higher;
• A containerization tool (e.g., Docker, Podman, etc.)

Start Environment

Open one terminal and inside the springboot-jpa-studies root folder run:

docker compose up -d

Useful Commands

• MySQL

  • Run MySQL interactive terminal (mysql)

    docker exec -it -e MYSQL_PWD=secret mysql mysql -uroot --database studiesdb
    

    Type exit to exit

• PostgreSQL

  • Run Postgres interactive terminal (psql)

    docker exec -it postgres psql -U postgres -d studiesdb
    

    Type \q to exit

Shutdown Environment

• In a terminal, make sure you are inside the springboot-jpa-studies root folder;

• To stop and remove docker compose containers, networks and volumes, run:

  docker compose down -v
  

Running tests

• In a terminal, make sure you are in the springboot-jpa-studies root folder;

• The commands below will run the test cases of all modules. In order to run just the tests of a specific module check the module README;

  During the tests, Testcontainers automatically starts Docker containers of the databases before the tests begin and shuts the containers down when the tests finish;

  • Using MySQL

    ./mvnw clean test -DargLine="-Dspring.profiles.active=mysql-test"
    

  • Using PostgreSQL

    ./mvnw clean test -DargLine="-Dspring.profiles.active=postgres-test"
    

Code Formatting

This project enforces consistent Java formatting using the Spotless Maven plugin with google-java-format (GOOGLE style).

• Check formatting:

  ./mvnw spotless:check
  

• Auto-fix formatting:

  ./mvnw spotless:apply
  

Formatting is enforced automatically during ./mvnw verify.

Support

If you find this useful, consider buying me a coffee:

License

This project is licensed under the MIT License.