NCSU-Group7-SE2021 / Binge

A Google Chrome Extension that provides all the information you need about movies / series on streaming platforms.
Apache License 2.0
0 stars 5 forks source link
chrome-extension javascript

![Logo](client/assets/images/Binge.jpeg)

Binge

[![License](https://img.shields.io/github/license/NCSU-Group7-SE2021/Binge)](https://github.com/NCSU-Group7-SE2021/Binge/blob/main/LICENSE) [![DOI](https://zenodo.org/badge/406509089.svg)](https://zenodo.org/badge/latestdoi/406509089) [![codecov](https://codecov.io/gh/NCSU-Group7-SE2021/Binge/branch/main/graph/badge.svg?token=CLARNXH3Q0)](https://codecov.io/gh/NCSU-Group7-SE2021/Binge) [![build](https://github.com/NCSU-Group7-SE2021/Binge/actions/workflows/node.js.yml/badge.svg)](https://github.com/NCSU-Group7-SE2021/Binge/actions/workflows/node.js.yml) [![CodeQL](https://github.com/NCSU-Group7-SE2021/Binge/actions/workflows/code-ql.yml/badge.svg)](https://github.com/NCSU-Group7-SE2021/Binge/actions/workflows/code-ql.yml)

Homeworks!
Assignment!
Projects!

We all got to take a break. Have you ever been tired and wished to NETFLIX & CHILL.
Did you go and waste your time choosing what to watch till your food went cold?
This new extension aims to provide quality and essential information about the video contents to the users that will help them get the best streaming experience.

Alot of users look out for details like ratings, people's reviews, critic's reviews and cast information before deciding to watch a movie or series.

[comment]: <Although each of the streaming platform provides some suggestions based on peer likeability, user's watch pattern and their sophisticated recommendation engines, most of them don't serve some critical information available on the internet. Some common platforms like IMDB, Rotten Tomatoes still have a reputable rating and review mechanism which the world looks out for.>

'BINGE' - is a Google Chrome Extension which provides information about ratings, reviews, trivia, cast details etc on the home and watch screen of video streaming platforms. This saves a lot of time and effort for the users and acts as a one stop place to get quick access to required information about the content.

Click to Play

Intro Video

Table of Content

  1. Features
  2. Installation
  3. Usage
  4. Repository Structure
  5. License
  6. Meet the contributors
  7. Additional Link

Features: What you get

  1. IMDB Ratings
  2. Rotten Tomatoes IMDB and Rotten Tomato ratings
  3. Metacritic Reviews IMDB and Rotten Tomato ratings
  4. Cast Information IMDB and Rotten Tomato ratings

What you can expect in future

  1. Serve more video platforms
  2. Recommendations
  3. Search what to watch and where (wait F.R.I.E.N.D.S is not on Netflix, come on HBO)
  4. Trivia

Installation

A guide to direct user on how to install the repository is a step towards making a descriptive project. Here is our guide on how to install this project on your local environment.

This project is developed using Vanilla JS. No other packages and libraries are required. There are a few steps to setup the chrome extension on the browser to run it locally.

  1. Clone the repository using git clone https://github.com/NCSU-Group7-SE2021/Binge.git
  2. Type chrome://extensions in a tab to bring up the extensions page.
  3. Once on this page, check Developer mode to enable loading unpacked extensions. This will allow you to load your extension from a folder.
  4. Finally, click Load unpacked extension or simply drag the “BINGE” folder onto the page to load up the extension.
  5. You should immediately see the extension show up as a Browser Action with your icon in the toolbar window of the current tab.

Usage

  1. To test out the extension, navigate to https://www.netflix.com/browse.
  2. Then, go ahead and click the icon for our BINGE extension.
  3. Hover over the movie tiles on the screen and you should see the ratings right away.
  4. Click on the expand section to see the ratings and trivia information.
  5. Hover on the watch screen to get detailed description about the cast.

Repository Structure

The repository is structured as Client and Server directories separately. The CLIENT directory contains all the files necessary to create and modify the UI aspects of the application. The files in the SERVER directory contains some backend logics that parses and fetches the data for every movie / show title referred from the client.

All Chrome extensions require a MANIFEST file. The Manifest file tells Chrome everything it needs to know to properly load up the extension in Chrome.

License

Each repository should get a license. To understand more about licensing, please refer this

This repository is Apache 2.0 licensed.

Meet the contributors

  1. Eshita Arza
  2. Isha Gupta
  3. Kiran Teja
  4. Luis
  5. Rahul Kalita
  6. Vignesh Muthukumar

Additional Link

  1. Want to contribute? Here is how you can do it.
  2. Project Standards? Say no more. Read this