README.md

service-mdh

Building

To build the application, you will need to have Maven 3 and a Java 8 implementation installed (OpenJDK and Oracle Java SE are both supported).

Now you can build the runnable shaded JAR:

$ mvn clean package

Running

The application is a RestEASY JAX-RS application, that by default is run under the Jetty server on port 8080 (if you use the packaged JAR).

Defaults

Running the following command will start the service listening on 0.0.0.0:8080:

$ java -jar target/service-mdh.jar

Heroku

This service is compatible with Heroku, and can be deployed by doing the following (assuming you're using git):

# If you've never logged in with Heroku via the CLI
$ heroku login

# Create an app for the service in Heroku, and add the Git remote
$ heroku create

# Deploy the app
$ git push heroku master

More information can be found here.

Contributing

Contributions are welcome to the project - whether they are feature requests, improvements or bug fixes! Refer to CONTRIBUTING.md for our contribution requirements.

License

This service is released under the MIT License.