diff --git a/README.md b/README.md index 262dee0e3..2bff04aed 100644 --- a/README.md +++ b/README.md @@ -1,68 +1,35 @@ -# PopcornPicks: Your Destination for Movie Recommendations 🎥 - A collaborative filtering based recommendation engine! - - -[![ForTheBadge built-with-love](http://ForTheBadge.com/images/badges/built-with-love.svg)](https://GitHub.com/ssp4all/) - - - +# PopcornPicks: Your Destination for Movie Recommendations 🍿 [![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://gitHub.com/adipai/PopcornPicks/graphs/commit-activity) [![Contributors Activity](https://img.shields.io/github/commit-activity/m/adipai/PopcornPicks)](https://github.com/adipai/PopcornPicks/pulse) [![GitHub issues](https://img.shields.io/github/issues/adipai/PopcornPicks.svg)](https://github.com/adipai/PopcornPicks/issues/) [![GitHub issues-closed](https://img.shields.io/github/issues-closed/adipai/PopcornPicks.svg)](https://github.com/adipai/PopcornPicks/issues?q=is%3Aissue+is%3Aclosed) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com) [![License: MIT](https://img.shields.io/badge/License-MIT-red.svg)](https://opensource.org/licenses/MIT) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4127507.svg)](https://doi.org/10.5281/zenodo.4127507) [![Build Status](https://travis-ci.com/adipai/PopcornPicks.svg?branch=master)](https://travis-ci.com/adipai/PopcornPicks) [![codecov](https://codecov.io/gh/adipai/PopcornPicks/branch/master/graph/badge.svg?token=8K0VL8106C)](undefined) [![GitHub release](https://img.shields.io/github/release/adipai/PopcornPicks.svg)](https://GitHub.com/adipai/PopcornPicksreleases/) [![black](https://img.shields.io/badge/StyleChecker-black-purple.svg)](https://pypi.org/project/black/) -### Project 3 Plan - -(Please see [wiki](https://github.com/git-ankit/MovieRecommender/wiki/Project-3-Plan) for detailed information.) - -Testing how good the Movie Recommender is : - -1. Pick 10-15 very famous movies. -2. Make sure the movies have diversity based on genre, cast and production style. -3. Show users a set of 10 randomly generated movies vs top 10 movies recommended by the Movie Recommender. -4. Also ask the user how satisfied is he/she with the recommended movies. -4. Collect your results and quantify them. - -Note: Our system can be virtually uploaded to sites like [Code SandBox](https://codesandbox.io/), for easier testing. - -Make sure you taste your own medicine first and take into account other peoples familiarity with the system before you design your tests. - - -### Video ▶️ - -logo here - - - -### Working 📱 -![Demo](https://raw.githubusercontent.com/git-ankit/MovieRecommender/master/asset/demo.gif) +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. +### Overview +PopcornPicks is a webapp where you can get movie recommedations based the movies you like ### Tech stack 👨‍💻 -- Python, Flask, HTML, CSS and JavaScript - -### Requirements and Setup ⚙️ - - -- python 3.5 + -- pip -- Style check - black - `pip install black` -- Static code analyser - Pylance - `Install it in VS Code` - -- Install all required python packages - `pip install -r requirements.txt ` + -### Usage -1. `cd Code/recommenderapp` -2. `python3 app.py` - -![Execution](https://raw.githubusercontent.com/git-ankit/MovieRecommender/master/asset/execution.gif) +### Getting Started +1. Clone the repository from GitHub. +2. Follow the setup instructions in the documentation. +3. Start enjoying personalized movie recommendations! ### Documentation 📚 Refer to Wiki page [here](https://github.com/git-ankit/MovieRecommender/wiki/Documentation) - ### Bug? 🐛 Raise a issue on this repository, we would love to look at it ❤️ + +### Contributors + + +### 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!