Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rishi2019194 authored Oct 18, 2023
1 parent e4df6de commit fa1b894
Showing 1 changed file with 42 additions and 19 deletions.
61 changes: 42 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,33 @@
# <i> PopcornPicks: Your Destination for Movie Recommendations 🍿 </i>
# <i> PopcornPicks🍿: Your Destination for Movie Recommendations </i>
[![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) [![Unittest](https://github.com/adipai/PopcornPicks/actions/workflows/unittest.yml/badge.svg?branch=master&event=push)](https://github.com/adipai/PopcornPicks/actions/workflows/unittest.yml) [![codecov](https://codecov.io/gh/adipai/PopcornPicks/graph/badge.svg?token=0XN6K2DMGS)](https://codecov.io/gh/adipai/PopcornPicks) [![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/)

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)
- [Documentation](#documentation)
- [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:]
- [Steps for Execution:](#getting-started)
- [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?)
- [Contribution](#contributions-to-the-project)
- [License](#license)
-
## Why use PopcornPicks

## 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"
/>

PopcornPicks: Your movie recommender! Input movies, get tailored suggestions, and share via email. Elevate your movie choices effortlessly!

- **Efficient:** Lightning-fast recommendations for movie buffs! 🚀
Expand All @@ -28,17 +37,17 @@ PopcornPicks: Your movie recommender! Input movies, get tailored suggestions, an
- **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 - [here](https://github.com/adipai/PopcornPicks/wiki)
## 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👨‍💻:

Expand All @@ -60,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
Expand Down

0 comments on commit fa1b894

Please sign in to comment.