Skip to content

Latest commit

 

History

History
79 lines (52 loc) · 3.51 KB

File metadata and controls

79 lines (52 loc) · 3.51 KB

TimeSeriesDataCapture_BrowseData

Implementation of the BrowseData interface, described in TimeSeriesDataCapture

Deploy

Building

Prerequisites

Deployment

Heroku

To build the Browse API on heroku simply click the Deploy To Heroku button above

Localhost

To build browse locally first the API swagger.yaml file must be modified.

Locate the host on Line 10 and change host: <url> to host: "localhost:8000"

Locate the schemes on Line 16 and change - "https" to -http

To start server run:

node index.js

Environment Variables

Variable Example Description
DEBUG * Node debugging. Defines what components produce logging. Usually set to *
PORT 443 Notionally, this variable is set to 443, but it simply exists as a placeholder for heroku. When running locally use 8000
AUTH_CLIENTID AUTH CLIENT ID Must be passed to Auth0 as a parameter.Client ID associated with the App name in the Auth0 account.
AUTH_APP_NAME AUTH APP NAME Auth0 application name
RSA_URI RSA_URI Auth0 /jwks.json endpoint
AUTH_URL AUTH_URL Auth0 /authorize endpoint
AUTH_AUDIENCE AUTH AUDIENCE Auth0 /user endpoint
IMPORT_URI IMPORT URI The URI of the Import API
DATABASE_HOSTNAME DATABASE HOSTNAME MongoDB database hostname (ds34237452745.mlab.com)
DATABASE_PORT DATABASE PORT MongoDB database port number
DATABASE_NAME DATABASE NAME MongoDB database name
DATABASE_USERNAME DATABASE USERNAME MongoDB database user username
DATABASE_PASSWORD DATABASE PASSWORD MongoDB database user password
API_SCHEME API SCHEME Scheme for api (either http or https)
API_DOMAIN API DOMAIN Domain for api
API_PORT API PORT Port for api

Auth0

Auth App Name,Auth Client ID,RSA URI and AUTH URL can be located on your Auth0 dashboard, Single Page Application.

Auth Audience can be located on your Auth0 dashboard, API section.

For help see Auth0

Database

Database URL, Database Username, Database Password and Database Name can be all found within the mLab dashboard


This project was funded via the Marloes Peeters Research Group and mentored by DigitalLabs@MMU as a DigitalLabs Summer Project. It is the work of Yusof Bandar.