kevinbonkewitzz/drive

BitId - Drive for MetWeb

biTid Drive

The Drive Application/Service is awesome

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

• Node
• MongoDB

Installing

  $ git clone [email protected]:bitid-open-source-iot/drive.git
  $ cd drive/
  $ cp config.template.json config.json
  # swap out "xxx" for real values
  $ mkdir logs
  $ npm i
  $ nodemon

Testing

We use Mocha together with Chai to run automated tests against all our apis. Complete the procedure below to test your version of Drive:

Installation

  $ cd test/
  $ cp config.template.json config.json
  $ nano config.json
  # swap out "xxx" for real values

Running

  # open terminal
  
  $ cd drive/
  # cd into project folder
  
  $ nodemon drive.js
  # run the service
  
  # open new terminal
  
  $ cd drive/test
  # cd into project's test folder
  
  $ mocha
  # run mocha test

Deployment

  $ cd drive/
  $ nano config.json
  # swap out "xxx" for real values
  # set production = true
  $ nodemon

Built With

• Node.js - Middleware
• Angular - Application
• MongoDB - Database

Versioning

For the versions available, see the tags on this repository.

Authors

• Shane Bowyer
• Clayton Constant

License

This project is licensed under the Apache License (Version 2) - see the LICENSE file for details