Tweetrics

Gain insights on individual twitter accounts using lexical analysis.

Team

• Guillaume Choupeaux
• Jonathan Kim
• Matthew Palamos
• Yessengerey Bolatov

Table of Contents

1. Usage
2. Requirements
   1. Developer Requirements
3. Development
   1. Installing Dependencies
4. Roadmap
5. Contributing

Usage

Checkout the app at https://tweetrics.herokuapp.com

Input a Twitter username of a person on whom you'd like to gain some insight. The app will retrieve some information about that Twitter account such as tweets, friends, mentions and etc using Twitter API and then perform a lexical analysis of tweets using Google Cloud Natural Language API. Based on the analysis of tweets and analysis of friends performed by our app, the app will estimate how influenced the given person is by the two political parties: Democrat and Republican.

Requirements

Developer Requirements

config.js file with:

• Twitter API key
• Google Cloud Natural Language API key
• MongoDB uri
• Heroku Account

Format of the config.js file

Twitter API key

var twitterKey = {
  consumerKey: 'YOUR_KEY_HERE',
  consumerSecret: 'YOUR_KEY_HERE',
  accessTokenKey: 'YOUR_KEY_HERE',
  accessTokenSecret: 'YOUR_KEY_HERE',
  bearerToken: 'YOUR_KEY_HERE'
};

We use Application Only based authentication

For Application Only based authentication, the keys used are: consumer_key: consumer_secret: bearer_token: => You will need to fetch a bearer token from Twitter see commented function in server.js

For User based authentication, the keys used are: consumer_key: consumer_secret: access_token_key: access_token_secret:

Google API Key

var googleLanguageKey = {
  'type': 'service_account',
  'project_id': '',
  'private_key_id': '',
  'private_key': '',
  'client_email': '',
  'client_id': '',
  'auth_uri': '',
  'token_uri': '',
  'auth_provider_x509_cert_url': '',
  'client_x509_cert_url': '
};

var mongodbUri = 'mongodb://...';

module.exports.twitterKey = twitterKey; module.exports.googleLanguageKey = googleLanguageKey; module.exports.mongodbUri = mongodbUri;

Development

Installing Dependencies

From within the root directory:

npm install
npm run react-dev (webpack -d --watch)
npm run server-dev (nodemon server/server.js)

Roadmap

View the project roadmap here

Contributing

See CONTRIBUTING.md for contribution guidelines.