CDP Java Spring Boot backend template.
A Docker Compose template is in compose.yml.
A local environment with:
- Floci for AWS services (S3, SQS)
- Redis
- MongoDB
- This service.
- A commented out frontend example.
docker compose --profile services up --build -dA more extensive setup is available in github.com/DEFRA/cdp-local-environment
Run infrastructure services (MongoDB, Floci, Redis):
docker compose --profile infra up -dAlternatively install MongoDB locally:
- Install MongoDB on your local machine
- Start MongoDB:
sudo mongod --dbpath ~/mongodb-cdpIn CDP environments a MongoDB instance is already set up and the credentials exposed as enviromment variables.
To inspect the Database and Collections locally:
mongoshYou can use the CDP Terminal to access the environments' MongoDB.
Run the tests with:
mvn testThere are also application level ests run by running a full Spring Boot application backed by Testcontainers. These tests do not use mocking of any sort and read and write from the containerized database.
mvn clean verifyRun the application:
mvn spring-boot:runExample SonarCloud configuration are available in the GitHub Action workflows.
We have added an example dependabot configuration file to the repository. You can enable it by
renaming
the .github/example.dependabot.yml to .github/dependabot.yml
The Open Government Licence (OGL) was developed by the Controller of Her Majesty's Stationery Office (HMSO) to enable information providers in the public sector to license the use and re-use of their information under a common open licence.
It is designed to encourage use and re-use of information freely and flexibly, with only a few conditions.