Mainstreet Analytics

Mainstreet Analytics is a real-time data visualization dashboard. It collects data from Twitter API, Google Trends API, and NY Times API and uses AlchemyAPI sentiment analysis to provide company specific and overall market insights as a resource to help investors make investment decisions by "predicting the present."

Table of Contents

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

Usage

Some usage instructions

Development

Installing Dependencies

From within the root directory:

npm install

Configuring API keys

You'll need to sign-up for access to Twitter API and IBM Watson AlchemyAPI to run this application. Once you receive your keys/access tokens, follow below instructions:

- Make a copy of _config.js file (found in the server/config folder)
- Re-name the file to config.js
- Insert your Twitter API keys and access tokens

Starting the Application

npm start

Run tests

npm test

Contributing

See CONTRIBUTING.md for contribution guidelines.