Home - Shravsssss/MovieRecommender GitHub Wiki

Welcome to StreamR ๐Ÿฟ Wiki

Your movie night assistant powered by collaborative filtering recommendations!

ForTheBadge built-with-love

Maintenance Contributors Activity GitHub issues GitHub issues-closed PRs Welcome License: MIT Code Coverage codecov GitHub release black

Skip the endless scroll, StreamR has your next movie pick ready!

Are you spending more time picking a movie than actually watching one? Let StreamR solve your movie-night dilemma! Just let us know your preferences, and StreamR will recommend must-watch movies tailored just for you. ๐Ÿฟ๐ŸŽฌ

movie night

Table of Contents

Overview ๐Ÿ‘๏ธ

Welcome to StreamR! ๐Ÿš€
Let us handle the hard part of picking a movie. Just provide your movie titles, and we'll curate a list of top recommendations perfect for your taste! ๐Ÿ“ฝ๏ธ
Save time and make every movie night a hit. StreamR delivers recommendations based on your unique preferences so you can focus on the popcorn! ๐Ÿฟ
Start your next great movie experience with a single click. ๐ŸŽ‰

Choosing a Movie

Exciting Future Plans ๐Ÿ”ฎ

Our vision for StreamR includes:

  1. Introducing more diverse genre, rating based recommendations.
  2. Emailing users their latest recommendations for easy access.
  3. Add multiple pages to go through more movies and reviews for search.
  4. Enable sharing through social media and other options.
  5. Add a subscribe option so that users can get emails according to their profile whenever a new movie is released.
  6. Add an option for creating groups with shared watchlists.

StreamR can also be continuously tested with GitHub Actions, keeping our codebase rock-solid! ๐Ÿ’ช

Demo Video โ–ถ๏ธ

Get a sneak peek of StreamR in action! Click the link to watch the demo.

B27Q7N5NE0FD6SR7.mp4

Watch the demo video here

How StreamR Works ๐Ÿ“ฑ

StreamR does more than just recommend movies. Hereโ€™s whatโ€™s under the hood:

  • Analyzes movie characteristics like genre and user reviews to make informed suggestions.
  • Combines movie features and user preferences using machine learning for truly personalized picks.
  • Suggests trailers for your top recommendations so you can preview before you watch.
  • Learns from feedback and improves recommendations with time.
  • Lets you create an account, track movie history, add to watchlist, edit profile, and refine your recommendations.

Watching Movies

Tech Stack ๐Ÿ‘จโ€๐Ÿ’ป

Python Python is our core programming language, ideal for building the recommendation engine with its simplicity and power.
Flask Flask serves as the backbone of our web app, making it easy to create and manage a dynamic and interactive user interface.
HTML & CSS HTML structures our content, while CSS styles it to make sure you enjoy a sleek and user-friendly design.
JavaScript JavaScript adds interactivity to our app, giving users a seamless experience.

Setup and Installation โš™๏ธ

To get started with StreamR:

  • Python 3.5+
  • pip
  • Code Formatter - black pip install black
  • Code Linter - Pylance (install it in VS Code)

Install Dependencies

After cloning, install dependencies with:

pip install -r requirements.txt

Getting Started

  1. cd Code/recommenderapp
  2. Run the application with:
    python3 app.py
  3. Visit localhost:5000 in your browser to start exploring!

Starting App

Documentation ๐Ÿ“š

Check out the Wiki documentation for detailed information on how StreamR works and how to contribute.

Found a Bug? ๐Ÿ›

Weโ€™d love to hear from you! Please open an issue if you find any bugs or have feature requests.

License ๐Ÿ“ƒ

StreamR is open-source under the MIT License.

  • We chose the MIT license to promote freedom and flexibility for you to adapt StreamR to your needs.
  • Enjoy, share, and contribute back to the community!
โš ๏ธ **GitHub.com Fallback** โš ๏ธ