forked from git-ankit/MovieRecommender
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #58 from adipai/readme_branch2
Readme branch2
- Loading branch information
Showing
1 changed file
with
62 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,22 +1,53 @@ | ||
| # <i> PopcornPicks: Your Destination for Movie Recommendations 🍿 </i> | ||
| # <i> PopcornPicks🍿: Your Destination for Movie Recommendations </i> | ||
| [](https://gitHub.com/adipai/PopcornPicks/graphs/commit-activity) [](https://github.com/adipai/PopcornPicks/pulse) [](https://github.com/adipai/PopcornPicks/issues/) [](https://github.com/adipai/PopcornPicks/issues?q=is%3Aissue+is%3Aclosed)  [](http://makeapullrequest.com) [](https://opensource.org/licenses/MIT) [](https://doi.org/10.5281/zenodo.4127507) [](https://github.com/adipai/PopcornPicks/actions/workflows/unittest.yml) [](https://codecov.io/gh/adipai/PopcornPicks) [](https://GitHub.com/adipai/PopcornPicksreleases/) [](https://pypi.org/project/black/) [](https://github.com/pylint-dev/pylint) [](https://hits.dwyl.com/adipai/PopcornPicks)    | ||
|
|
||
| PopcornPicks is more than just a movie recommender system; it's a gateway to a world of cinematic adventures. With an ever-expanding library of films and a powerful recommendation algorithm, PopcornPicks is here to transform the way you discover, enjoy, and connect with movies. | ||
| <img src="https://github.com/adipai/PopcornPicks/blob/master/asset/header_display.png" alt="drawing" style="width:1000px;"/> | ||
| <b>PopcornPicks is more than just a movie recommender system; it's a gateway to a world of cinematic adventures. With an ever-expanding library of films and a powerful recommendation algorithm, PopcornPicks is here to transform the way you discover, enjoy, and connect with movies.</b> | ||
|
|
||
| # Table of Contents | ||
|
|
||
| - [Why use PopcornPicks?](#why-use-popcornpicks) | ||
| - [Project Documentation](#documentation) | ||
| - [Project Presentation Video](#project-presentation-video) | ||
| - [Brief Overview of Project](#project-description) | ||
| - [Improvements Made in the Project](#project-2-delta) | ||
| - [TechStack Used for the Development of Project](#tech-stack-used) | ||
| - [Core Applications of the Project](#core-applications-of-the-project) | ||
| - [Steps for Execution](#getting-started) | ||
| - [Future Scope](#future-scope) | ||
| - [Team Members](#contributors) | ||
| - [Contribution](#contributions-to-the-project) | ||
| - [License](#license) | ||
|
|
||
| ## Why use PopcornPicks? | ||
|
|
||
| <img | ||
| src="https://github.com/adipai/PopcornPicks/blob/master/asset/landing_page.png" | ||
| alt="Starship with iTerm2 and the Snazzy theme" | ||
| width="50%" | ||
| align="right" | ||
| /> | ||
|
|
||
| ## Goal | ||
| PopcornPicks: Your movie recommender! Input movies, get tailored suggestions, and share via email. Elevate your movie choices effortlessly! | ||
|
|
||
| ## Documentation 📚 | ||
| Checkout for project documentation at - [here](https://github.com/adipai/PopcornPicks/wiki) | ||
| - **Efficient:** Lightning-fast recommendations for movie buffs! 🚀 | ||
| - **Adaptable:** Tailor the recommendations to your taste. | ||
| - **Accessible:** Works across all platforms and shells. | ||
| - **Insightful:** Get movie insights at a glance. | ||
| - **Comprehensive:** Supports a wide array of user-preferred movies. | ||
| - **Simple:** Easy installation and setup – start discovering great movies in no time!" | ||
|
|
||
| ## Documentation | ||
| Checkout for project documentation at our [Wiki-Page](https://github.com/adipai/PopcornPicks/wiki) | ||
|
|
||
| ## Project Presentation Video | ||
| You can see the project presentation at - . | ||
|
|
||
| ## Project Description | ||
| PopcornPicks is a user-friendly movie recommender that curates a tailored list of 10 movie predictions based on user-provided movie preferences. Users can input their favorite movies, and our algorithm refines recommendations based on feedback—Liked, Disliked, or Yet To Watch. Additionally, PopcornPicks offers the convenience of emailing the recommended movies, enhancing the movie-watching experience. | ||
| PopcornPicks is a user-friendly movie recommender that curates a tailored list of 10 movie predictions based on user-provided movie preferences. Users can input their favorite movies, and our algorithm refines recommendations based on feedback—Liked, Disliked, or Yet To Watch. Additionally, PopcornPicks offers the convenience of emailing the recommended movies, enhancing the movie-watching experience. For the system architecture and other details, please refer to our [wiki-page](https://github.com/adipai/PopcornPicks/wiki) | ||
|
|
||
| ## Project 2 Delta | ||
| Checkout the changes that we made for Project 2 [here](https://github.com/adipai/PopcornPicks/wiki/Installation-and-setup) | ||
| Checkout the significant changes that we made for Project 2 [here](https://github.com/adipai/PopcornPicks/wiki/Installation-and-setup) | ||
|
|
||
| ## Tech stack Used👨💻: | ||
|
|
||
|
|
@@ -38,14 +69,28 @@ Checkout the changes that we made for Project 2 [here](https://github.com/adipai | |
|
|
||
| ## Getting Started | ||
|
|
||
| 1. Clone the repository from [GitHub](https://github.com/adipai/PopcornPicks). | ||
| 2. Follow the setup instructions in the [documentation](https://github.com/adipai/PopcornPicks/wiki/Installation-and-setup). | ||
| 3. Start enjoying personalized movie recommendations! | ||
|
|
||
| Step 1: | ||
| Git Clone the Repository | ||
|
|
||
| git clone https://github.com/adipai/PopcornPicks.git | ||
|
|
||
| (OR) Download the .zip file on your local machine from the following link | ||
|
|
||
| https://github.com/adipai/PopcornPicks | ||
|
|
||
| Step 2: | ||
| Follow the setup instructions in the wiki documentation | ||
|
|
||
| https://github.com/adipai/PopcornPicks/wiki/Installation-and-setup | ||
|
|
||
|
|
||
| <b>Finally, start enjoying personalized movie recommendations!</b> | ||
|
|
||
| ## Core Applications of the Project | ||
| ## Contact | ||
| In case of any issues, please e-mail your queries to [email protected] or raise an issue on this repository. | ||
|
|
||
| ## Contributions to the Project? 🐛 | ||
| ## Contributions to the Project? | ||
| Please refer to the [Contributing.md](https://github.com/adipai/PopcornPicks/blob/master/CONTRIBUTING.md) if you want to contribute to the PopcornPicks source code. Follow all the guidelines mentioned in the same and raise a pull request, we would love to look at it ❤️❤️! | ||
|
|
||
| ## Contributors | ||
|
|
@@ -54,10 +99,15 @@ Ananya Mantravadi<br/> | |
| Rishi Singhal<br/> | ||
| Samarth Shetty<br/> | ||
|
|
||
| ## Future Scope | ||
|
|
||
| ## Join the PopcornPicks Community: | ||
|
|
||
| Contribute to the project and help us improve recommendations. | ||
| Share your experience and film discoveries with us. | ||
| Together, let's make PopcornPicks the ultimate movie companion! | ||
| PopcornPicks is more than just code; it's a passion for cinema, and we invite you to be a part of this exciting journey. Start exploring, sharing, and discovering movies like never before with PopcornPicks ! | ||
| Let's make movie nights extraordinary together! | ||
|
|
||
| ## License | ||
| This project is under the MIT License. | ||