Project Name

Pithy project description

Team

• Product Owner: Artur Meyster
• Scrum Master: Michael Warner
• Git Master: Arian Faurtosh
• Development Team Members: Kuni Natsuki

Table of Contents

1. Usage
2. Requirements
3. Development
   1. Installing Dependencies
   2. Tasks
4. Team
5. Contributing

Usage

Some usage instructions

Requirements

• Node 0.10.x
• Redis 2.6.x
• MySQL 5.6.x

Enviroment Variables (process.env) being used

MySQL

• dbDatabase // MySQL Database
• dbUsername // MySQL Username
• dbPassword // MySQL Password
• dbHostname // MySQL Hostname

Yelp API

• oauth_consumer_key // Yelp API Consumer Key
• consumerSecret // Yelp API Consumer Secret
• oauth_token // Yelp API Token
• tokenSecret // Yelp API Token Secret

Port

• PORT // Used by azure

Development

Installing Dependencies

From within the root directory:

sudo npm install -g bower
npm install
bower install

Roadmap

View the project roadmap here

Contributing

See CONTRIBUTING.md for contribution guidelines.