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
Create the image of the application by executing the following command:
./gradlew installDist
Create docker image:
docker-compose build
Run the distribution (created in build/install/send-letter-producer-service
directory)
by executing the following command:
docker-compose up
This will start the API container exposing the application's port
(set to 8485
in this app).
In order to test if the application is up, you can call its health endpoint:
curl http://localhost:4550/health
You should get a response similar to this:
{"status":"UP","diskSpace":{"status":"UP","total":249644974080,"free":137188298752,"threshold":10485760}}
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.
To run migration gradle task expects FLYWAY_URL
to be present. In case db requires username/password: FLYWAY_USER
and FLYWAY_PASSWORD
. Once those variables are exported all flyway tasks are available.
./gradlew flywayMigrate
This project is licensed under the MIT License - see the LICENSE file for details