Project Name

Cliff on Mars

An advanced movie database that gives passionate movie fans and studio executives easy access to movie data and social media stats of recent films.

Team and Areas of Responsibility

• Joe: Google Trends data fetching, Twitter search API request, Watson NLP API request, data analysis
• Cliff: Documentation and testing
• Hubert: TMDB API, server setup, Material UI, and React / Redux.
• Tim: Recharts and database

Table of Contents

1. Usage
2. Requirements
3. Development
   1. Installing Dependencies
   2. Setting up Development server
4. Roadmap
5. Contributing

Usage

Point your browser at cliffonmarsdb.herokuapp.com

Requirements

• Node >= 8.0.0
• Express
• MongoDB
• React
• Recharts
• Redux
• Axios
• Google Trends API (npm library)
• Twitter API key
• Watson API key
• Material UI
• Mongoose
• Moment
• Path
• Webpack

Development

Installing Dependencies

From within the root directory:

npm install

Setting up Development Server

webpack && API_KEY=[YOUR TMDB API KEY] TWITTERAPI=[YOUR TWITTER API KEY] WATSONAPI=[YOUR WATSON API KEY] node app.js

Roadmap

View the project roadmap here and the plan here

Contributing

Communicate, commit often, and at least 1 peer should review pull requests.