Up and Running

So you wanna send notifications, do ya? I think we know a service.

Build and Package

noti is built and packaged using Apache Maven. Once you have Maven installed, start by changing into the project root directory (the folder with pom.xml) and run this command:

mvn package

The output of the packaging will be a shaded (also referred to as "fat" or "uber") .jar file, which can be found in the /target directory.

Docker Compose

When running noti locally or in a testing environment, we strongly recommend using Docker Compose. Within the /docker directory lies a special file named docker-compose.yml. This file defines the Docker configuration for noti, as well it's dependencies. Once you have Docker Compose installed, run the following command in the project's root directory to boot up noti and it's dependencies:

docker-compose --file ./docker/docker-compose.yml up

NOTE: When this command is ran, the output of each Docker container is interleaved to standard output. Control is not provided back to the shell. If you would like to start up noti (and it's dependencies) in the background, provide the -d (--detach) option: docker-compose --file ./docker/docker-compose.yml up -d.