README.md

Tweet Stats API

Realtime statistics on Twitter keywords

Demo: http://tweet-stats.herokuapp.com

Getting up and running

1. Create a free Pusher account
2. Create a Twitter application
3. Generate access tokens on the "Keys and Access Tokens" tab
4. Create a copy of config.example.js and name it config.js
5. Fill the configuation options with the values from Pusher and Twitter
6. Add the keywords you want to track as an array of strings in config.js
7. Install the dependencies by running npm install
8. Test the API locally by running node index.js and checking an API endpoint
9. Upload the API somewhere public (this is already set up for Heroku)
10. Set up the demo