Trendr: a trend visualization app for Twitter

Overview of Tech Stack

• Client: Angular
• Server: Express
• Twitter REST API
• Yahoo Geo API
• D3.js Visualizations: angular-nvd3, angular-datamaps, d3pie
• Hosting: Heroku (Web), AWS EC2 (Cron Job)
• DB: MongoDB, hosting on Mongolab

Getting Started with Trendr

• Fork the repo
• git clone https://github.com/your-username/trendr.git
• npm install will install both Bower and NPM dependencies
• Node Foreman is used to load environment variables. Create a .env file and add the following:

CONSUMER_KEY='TWITTER_CONSUMER_KEY'
CONSUMER_SECRET='TWITTER_CONSUMER_SECRET'
ACCESS_TOKEN_KEY='TWITTER_ACCESS_TOKEN_KEY'
ACCESS_TOKEN_SECRET='TWITTER_ACCESS_TOKEN_SECRET'
MONGOLAB_URI='mongodb://readonly:123@ds037165.mongolab.com:37165/mkstrendr'

• You will need access to the Mongolabs DB with current data to load charts. The one above is a read-only user.
• Take a look at the following wiki article on getting Twitter API keys.
• Starting the server: npm start. This will load any variables in .env and use nodemon by default.

Getting Started with the Cron Job

• See the Cron Job README.

Contributing

• See _CONTRIBUTING.md.

Product Backlog

• Please see the Github issues tab for user stories.

Resources and Knowledge Base

• Contributing to Trendr: things to ponder
• Trendr file structure
• Environment variables in production and development
• Using Trendr's Mongolab Data
• Using Twitter REST API
• Deploying to Heroku
• Running a cron job on EC2
• Using NPM

Authors

• Simon Ding
• Polina Soshnin
• Kevin Van
• Brandon Goodfliesh
• Geetha Ratnam