HealthKit-Consumer

Consumer Application to Receive published events from HealthKit's WatchOS application.

Getting Started

To get started with this project clone the repository with git clone https://github.com/cbartram/HealthKit-Consumer.git

Run mongodb with: $ docker run --name mongodb -p 27017:27017 -d -e MONGO_INITDB_ROOT_USERNAME=admin -e MONGO_INITDB_ROOT_PASSWORD=secret mongo:latest Connect to mongo with $ mongo -u admin -p secret --authenticationDatabase admin metrics

Prerequisites & Installation

Before you can run this project you will need to install several software programs to your machine. If you already have these programs you can omit this section.

• Java 11
• Gradle >= 6.3
• Docker
• MongoDB

Java 11

This project runs with Java version 11 and its required to get started developing with this application. You can download Java 11 through Homebrew the popular package manager for Mac.

With Homebrew installed you can download and install Java with:

$ brew update
$ brew tap homebrew/cask-versions
$ brew cask install homebrew/cask-versions/java11

You can validate your installation with:

$ java -version

Gradle

Once you have Java successfully installed you will need to download and install Gradle. Gradle is a build manager for Java and helps with managing dependencies, packaging up the executable Jar file, and running unit tests!

Install Gradle through Homebrew using the following command:

$ brew install gradle

Docker

// TODO

Mongo DB

Lastly you will need to have Mongo DB installed since it is the primary database for this Application. Luckily you can install Mongo DB with Homebrew by executing the following command:

$ brew tap mongodb/brew
$ brew install mongodb-community@4.2

Installing

Running the tests

Explain how to run the automated tests for this system

Break down into end to end tests

Explain what these tests test and why

Give an example

And coding style tests

Explain what these tests test and why

Give an example

Deployment

Add additional notes about how to deploy this on a live system

Architecture Diagram

The following image depicts the current architecture diagram for this system.

Built With

• Spring - The web framework used
• Gradle - Dependency Management & Build Tool
• Java - Programming Language

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Christian Bartram - Initial work - cbartram

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Reference Documentation

For further reference, please consider the following sections:

• Official Gradle documentation
• Spring Boot Gradle Plugin Reference Guide
• Spring Web
• Spring Data JPA

Guides

The following guides illustrate how to use some features concretely:

• Building a RESTful Web Service
• Serving Web Content with Spring MVC
• Building REST services with Spring
• Accessing Data with JPA

Additional Links

These additional references should also help you:

• Gradle Build Scans – insights for your project's build

Acknowledgments

• Spring for making a great framework!