Project Name

Vantage

Vantage aggregates social and traditional media using place and time to provide a panoramic view of interesting events.

Team

• Product Owner: Jason Erpenbeck
• Scrum Master: Richard Avendaño
• Development Team Members: Jamon Douglas, Kia Winslow, Richard Avendaño, Jason Erpenbeck

Table of Contents

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

Usage

TBD

Requirements

• Node 0.10.x
• Express 4.x
• Lo-Dash 2.4.x
• Grunt
• Bootstrap
• Cheerio
• Body Parser
• queryString
• Angular
• API access to Twitter, Instagram, Google

Development

Installing Dependencies

From within the root directory:

sudo npm install -g bower
sudo npm install -g jsdoc@"<=3.3.0"
npm install
bower install

Signup for a Twitter API Developer Key
Make a file named twitterKeys.js and place in server/
Use the following format:
module.exports.keys = {
  instaClientID: 'XXXXXXXXXXXXXXXXXXXXXXXXXXX',
  instaClientKey: 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX',
  instaToken: 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
};

Signup for an instagram API Developer Key.
Make a file named instaKeys.js and place in server/
Use the following format in file: 

module.exports = {
  consumerKey: 'XXXXXXXXXXXXXXXXXXXXXXXXXXX',
  consumerSecret: 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX',
  accessToken: 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX',
  accessTokenSecret: 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
};

To Utilize JSDocs:

grunt docs

Open docs/index.html to view JSDocs

Reference

See Reference.md for reference.

Contributing

See CONTRIBUTING.md for contribution guidelines.