Our code convention is fully compliant with Google Checks specifications. Read more here.
To configure this code convention in your IDE, use the Checkstyle plugin and the config file.
To run checkstyle, execute mvn clean verify -P checkstyle
To run application with docker compose you need to create backend network first, we already have the docker-compose-network.yml
so just run the command docker compose -f docker-compose.yml -f docker-compose-network.yml up
Application has other configuration for testing.
To use this config, mark all test classes with @ActiveProfiles("test")
To write integration tests, use @IntegrationTest (includes @ActiveProfiles("test")). There are two options:
- mark test class with this annotation
- make test class implement interface or extend class, marked with this annotation.
To run integration tests, follow next steps:
- install and run Docker on your local machine
- execute
mvn clean verify -P integration-test
After deployment, the Swagger UI page is available at http://localhost:8080/swagger-ui.html