Skip to content

README.md

Latest commit

 

History

History
25 lines (19 loc) · 1.26 KB

README.md

File metadata and controls

25 lines (19 loc) · 1.26 KB

Build Status Coverage Status

Please refer to the API Documentation.

Project Management is done through Pivotal Tracker.

Install Notes

  1. Install Node. This will also install npm.
  2. Install MongoDB.
  3. Clone this repo and navigate to the project root folder.
  4. Run git submodule update --init --recursive.
  5. Run npm install (This will download and install dependencies into /node_modules.
  6. Run mkdir database.
  7. Open a new terminal and run mongod --dbpath "./database". Keep this terminal open while running your local server.
  8. Run node server to start the local server on localhost.
  9. Go to localhost:8080 in your browser!

How to Contribute

  1. Fork this repo
  2. Make changes
  3. Make a pull request!
  4. The build must pass, and you must add test cases for any features you've added.