This is a Java based Spring Boot Application which will be hosted on Cloud Platform.
- Go through with this Java Developer On-boarding Check List and complete all tasks.
- Request a team member to be added to the repository.
- This is a document to outline the general guideline Developer Guidelines.
- Docker
- SSH
- An editor/IDE of some sort
- Gradle
- AWS CLI
- Kubernetes CLI
- Helm
- CircleCI CLI (optional)
We're using Gradle to build the application. This also includes plugins for generating IntelliJ configuration.
To run the app locally, you will need to download the appropriate environment variables from the team vault in 1Password. These environment variables are stored as a .env file, which docker-compose uses when starting up the service. If you don't see the team vault, speak to your tech lead to get access.
To begin with, make sure that you have the 1Password CLI installed:
op --version
If the command is not found, follow the steps on the 1Password developer docs to get the CLI set-up.
Once you're ready to run the application:
./start-local.sh
OpenAPI 3 specification is available here and Swagger UI here