BioNet 3 API

In Development. A Node Express Server that interfaces with the Bionet 3 Client.

Install

Requirements

Requires git and node both be installed and configured on your local environment.

Clone

From your terminal:

git clone https://github.com/biobricks/bionet-3-api.git

Change Directory To Project

cd bionet-3-api

Configure

In local development, the environment variables are expected to be located in /config/env.js which is not included in the git commit as it contains secure information not to be shared with the public.
In production the environment variables should be applied prior to deployment.
Below is an example that you can fill out and save to /config/env.js:

// /config/env.js
process.env.DB_USERNAME = "myDbUsername";
process.env.DB_PASSWORD = 'myDbPassword';
process.env.DB_URI = 'ds123456.mlab.com:12345/mydbname';
process.env.DB_TEST_URI = 'ds123456.mlab.com:12345/mytestdbname';
process.env.JWT_SECRET = 'mySuperSecretPasswordPhrase';

Install Modules

npm install

Start Server

node server

Run Tests

npm test