Seitenbau / service-kommune-tracker

A Ratpack REST Service to allow tracking of events in Service-BW / Amt24 processes

Serviceportal Tracking Server

A service to allow tracking of process events in the "Serviceportal" Service-BW, Amt24 and OZG-Hub.

Developed by SEITENBAU, in cooperation with #ANDI.

Prerequisites

1. Setup a MariaDB database (in the examples, we name it skTracker)
2. Set required environment variables:

   export DB_URL="jdbc:mysql://localhost:3306/skTracker";
   export DB_USERNAME="skTrackingService";
   export DB_PASSWORD="<YOUR PASSWORD HERE>";
   export DB_DRIVER="org.mariadb.jdbc.Driver"

Running the application

Via Docker

This assumes that you've already created a docker network called sk-tracker and there is a docker container in this network running MariaDb with the network-name mariadb. This also assumes this MariaDb has a database called sktracker, a user sktracker (and this user uses the password sktracker).

1. Pull an image from DockerHub (use the master tag for the master branch):

   docker pull dweberseitenbau/service-kommune-tracker:master

2. Run the image (replace 12415 with the port you want to use)

   docker run -d --net=sk-tracker --name=app -p 12415:5050 \
     --restart on-failure \
     -e DB_URL=jdbc:mysql://mariadb:3306/sktracker \
     -e DB_USERNAME=sktracker \
     -e DB_PASSWORD=sktracker \
     -e DB_DRIVER="org.mariadb.jdbc.Driver" \
     dweberseitenbau/service-kommune-tracker:master

Development

This project contains all files needed for an instant setup with the IntelliJ IDEA IDE. We suggest you simply clone the repository and import it via File --> Open.

Testing

After that you should be able to verify everything by running the 'All Tests' run configuration. Alternatively, you can use Gradle from the command line:

./gradlew test

Running the application

1. Run in development mode with auto-refresh:

   ./gradlew -t run

2. Optional: You can also do this from within IntelliJ. Just use the provided Run with local test DB run config. (Note that it assumes that the database username and password are both set to skTracker.

Building releases

1. This is super simply and happens all within gradle:

   ./gradlew clean test shadowJar

Licence & Contributing

This project, including all files in this repository, is licenced under the terms of the MIT Licence. Forking is welcome and contributions are encouraged. The preferred way is via a GitHub Pull Request or by starting a discussion via a Github Issue