Todo:
Before starting work, you need to:
- Create a
.env
file and specify the necessary environment variables in it (seeconfig/env/template.env
) - Optionally, generate self-signed certificates (see
config/certs/generate_certs.sh
)
mvn clean test jacoco:report
The minimum test coverage requirement for the project is 50%.
Two compose scripts are used, each with its own profile: backend
and idp
.
This needs to be taken into account!
mvn clean install
# Run backend along with the IdP
docker compose --profile "*" up -d --build
# e.g. see backend logs
docker logs -f backend
For further reference, please consider the following sections:
- Official Apache Maven documentation
- Spring Boot Maven Plugin Reference Guide
- Create an OCI image
- Spring Boot Testcontainers support
- Testcontainers Postgres Module Reference Guide
- Liquibase Migration
- Spring Web
- JOOQ Access Layer
- Testcontainers
The following guides illustrate how to use some features concretely:
- Building a RESTful Web Service
- Serving Web Content with Spring MVC
- Building REST services with Spring
This project uses Testcontainers at development time.
Testcontainers has been configured to use the following Docker images:
Please review the tags of the used images and set them to the same as you're running in production.