Wellness Building Block

The Wellness Building Block manages user wellness data, including wellness ring progress and todo lists, for the Rokwire platform.

Documentation

The functionality provided by this application is documented in the Wiki.

The API documentation is available here: https://api.rokwire.illinois.edu/wellness/doc/ui/index.html

Set Up

Prerequisites

MongoDB v4.2.2+

Go v1.16+

Environment variables

The following Environment variables are supported. The service will not start unless those marked as Required are supplied.

Name	Format	Required	Description
PORT	< int >	yes	Port to be used by this application
WELLNESS_MONGO_AUTH	<mongodb://USER:PASSWORD@HOST:PORT/DATABASE NAME>	yes	MongoDB authentication string. The user must have read/write privileges.
WELLNESS_MONGO_DATABASE	< string >	yes	MongoDB database name
WELLNESS_MONGO_TIMEOUT	< int >	no	MongoDB timeout in milliseconds. Defaults to 500.
WELLNESS_MULTI_TENANCY_APP_ID	< string >	yes	Application ID for migrating existing data to multi-tenancy
WELLNESS_MULTI_TENANCY_ORG_ID	< string >	yes	Organization ID for migrating existing data to multi-tenancy
WELLNESS_HOST	< url >	yes	URL where this application is being hosted
WELLNESS_CORE_BB_HOST	< url >	yes	Core BB host URL
WELLNESS_SERVICE_URL	< url >	yes	URL where this application is being hosted
INTERNAL_API_KEY	< string >	yes	Internal API key for invocation by other BBs

Run Application

Run locally without Docker

1. Clone the repo (outside GOPATH)

2. Open the terminal and go to the root folder

3. Make the project

$ make
...
▶ building executable(s)… 1.9.0 2020-08-13T10:00:00+0300

4. Run the executable

$ ./bin/wellness

Run locally as Docker container

1. Clone the repo (outside GOPATH)

2. Open the terminal and go to the root folder

3. Create Docker image

docker build -t wellness .

4. Run as Docker container

docker-compose up

Tools

Run tests

$ make tests

Run code coverage tests

$ make cover

Run golint

$ make lint

Run gofmt to check formatting on all source files

$ make checkfmt

Run gofmt to fix formatting on all source files

$ make fixfmt

Cleanup everything

$ make clean

Run help

$ make help

Generate Swagger docs

$ make swagger

Test Application APIs

Verify the service is running as calling the get version API.

Call get version API

curl -X GET -i http://localhost/wellness/version

Response

1.9.0

Contributing

If you would like to contribute to this project, please be sure to read the Contributing Guidelines, Code of Conduct, and Conventions before beginning.

Secret Detection

This repository is configured with a pre-commit hook that runs Yelp's Detect Secrets. If you intend to contribute directly to this repository, you must install pre-commit on your local machine to ensure that no secrets are pushed accidentally.

# Install software 
$ git pull  # Pull in pre-commit configuration & baseline 
$ pip install pre-commit 
$ pre-commit install