README.md

Dispenser Backend (DPB) - Pillwatcher

DPB Service is an API aimed at feeding any patient's Medication and Prescription control platforms. It can be consumed by both mobile and electronic components.

• Validated through Travis CI and SonarCloud.
• Fully documented with Swagger
• Cloud deployed to fit different users
• Implements HATEOAS pattern

Usage

Java + Maven Endpoint

DPB Service uses some Maven provided plugins. It can be build and run through Java 8 and Maven. In that case, those links will be useful:

Windows

1. Installing Java on Windows

2. Install Maven on Windows

Ubuntu

1. Installing Java on Ubuntu

2. Installing Maven on Linux

MacOS

1. Installing Java on MacOS

2. Installing Maven on MacOS

All set, use the following commands:

$ mvn clean install   # This command will install all maven dependencies
$ mvn clean compile   # This command will run CodeGen to create necessary Interfaces
$ mvn spring-boot:run # This command will run the Project

Docker Endpoint

Windows

1. Installing Docker on Windows

Ubuntu

1. Installing Docker on Ubuntu

MacOS

1. Installing Docker on MacOS

All set, use the following commands:

$ docker-compose up    # This command will start both database and Spring Project (no Java or Maven download necessary)
$ docker-compose up -d # This command will do the same but without logs and you will be able to use same terminal instance

To see docker-compose logs using -d flag, use the command docker-compose --logs