noms-digital-studio/rsr-calculator-service

Name: rsr-calculator-service

Owner: NOMS Digital Studio

Description: A Restful service to calculate risk on a known set of parameters

Created: 2017-02-24 22:20:44.0

Updated: 2018-04-11 10:59:08.0

Pushed: 2018-04-12 10:28:52.0

Homepage: https://noms-digital-studio.github.io/rsr-calculator-service/

Size: 968

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

Risk Calculator Service

A Restful service to calculate risk on a known set of parameters.

Swagger documentation

The details of the API can found in the online documentation.

The swagger specification can be found on the path `/api-docs`.

Running with NodeJS

Start by ensuring you have the most recent version of NodeJS and NPM installed.

Pre-requisites

To find the current version of NodeJS installed on your system, run the following command in your preferred shell;

de -v

If you have the latest versions installed you need to get the dependencies loaded, run the following command in your preferred shell;

m install

Running the tests

If you have all the Pre-requisites then you are ready to run the tests. Call the following from your shell;

m test

Running the server

If you have all the Pre-requisites then you are ready to run the service. Call the following from your shell;

m start

Running the server with raw logs

If you wish to have the output in raw JSON, then you can run the server without piping it through bunyan's formatter. Call the following from your shell;

de server.js