This repository contains the code for both the front-end and the back-end apps. The front-end is build with AngularJS and the back end is build on NodeJS.
Before you can get the app up and running for some development, you're going to need to install a few things.
- npm - Node Package Manager. Lets the app run.
- Node.js - Needed to run the server
- nodemon (
sudo npm install -g nodemon
) - A package to restart the server every time a save is made. - MongoDB - The database that the app pulls data from. Get this setup running on http://localhost:27017/
- Run
npm install
. This will install all required dependencies
mongod
- Starts the MongoDB servernpm start
- Runs the nodemon command
Please follow these guidelines for submitting a new feature or fixing a bug
- Pull master -
git pull
- Create a new branch -
git checkout -b username/feature-or-bug-fix-name
- Do your code. Add and commit locally
- Checkout master -
git checkout master
- Pull master -
git pull
- Switch to your branch -
git checkout username/feature-or-bug-fix-name
- Rebase against master -
git rebase master
- Push your changes -
git push origin username/feature-or-bug-fix-name
- Open a pull request.