Please refer to the API Documentation.
Project Management is done through Pivotal Tracker.
- Install Node. This will also install
npm. - Install MongoDB.
- Clone this repo and navigate to the project root folder.
- Run
git submodule update --init --recursive. - Run
npm install(This will download and install dependencies into /node_modules. - Run
mkdir database. - Open a new terminal and run
mongod --dbpath "./database". Keep this terminal open while running your local server. - Run
node serverto start the local server on localhost. - Go to
localhost:8080in your browser!
- Fork this repo
- Make changes
- Make a pull request!
- The build must pass, and you must add test cases for any features you've added.