juror-pnc

Building and deploying the application

Environmental Variables

SECRET=

PNC_SERVICE_HOST
PNC_SERVICE_POST
PNC_SERVICE_USERNAME
PNC_SERVICE_PASSWORD

PNC_SERVICE_PNC_TERMINAL
PNC_SERVICE_PNC_USERID
PNC_SERVICE_PNC_MODE
PNC_SERVICE_PNC_AUTHORISATION
PNC_SERVICE_PNC_TRAN_CODE
PNC_SERVICE_ORIGINATOR
PNC_SERVICE_REASON_CODE
PNC_SERVICE_GATEWAY_ID
PNC_SERVICE_REQUEST_LOCATION


JUROR_SERVICE_HOST
JUROR_SERVICE_PORT
JUROR_SERVICE_SECRET

JOB_EXECUTION_SERVICE_HOST
JOB_EXECUTION_SERVICE_PORT
JOB_EXECUTION_SERVICE_SECRET

Building the application

The project uses Gradle as a build tool. It already contains ./gradlew wrapper script, so there's no need to install gradle.

To build the project execute the following command:

  ./gradlew build

Running the application

Create the image of the application by executing the following command:

  ./gradlew assemble

Create docker image:

  docker-compose build

Run the distribution (created in build/install/juror-pnc-check-service directory) by executing the following command:

  docker-compose up

This will start the API container exposing the application's port (set to 8080 in this template app).

In order to test if the application is up, you can call its health endpoint:

  curl http://localhost:8080/health

You should get a response similar to this:

  {"status":"UP","diskSpace":{"status":"UP","total":249644974080,"free":137188298752,"threshold":10485760}}

Alternative script to run application

To skip all the setting up and building, just execute the following command:

./bin/run-in-docker.sh

For more information:

./bin/run-in-docker.sh -h

Script includes bare minimum environment variables necessary to start api instance. Whenever any variable is changed or any other script regarding docker image/container build, the suggested way to ensure all is cleaned up properly is by this command:

docker-compose rm

It clears stopped containers correctly. Might consider removing clutter of images too, especially the ones fiddled with:

docker images

docker image rm <image-id>

There is no need to remove postgres and java or similar core images.

License

This project is licensed under the MIT License - see the LICENSE file for details