https://github.com/mohitbharambe/reel-rec
Reel Rec - A Movie Recommendation App designed to change the way movie enthusiasts discover and enjoy favorite films. Made using Django & Tailwind CSS.
https://github.com/mohitbharambe/reel-rec
btech-project collaborate content-based-recommendation django-project final-year-project finalyearproject jetbrains machine-lear machinelearning-python movie-recommedation movie-recommendation-app python python-project recommendation-algorithm recommendation-system reel-rec tailwindcss webapp webapplication
Last synced: 3 months ago
JSON representation
Reel Rec - A Movie Recommendation App designed to change the way movie enthusiasts discover and enjoy favorite films. Made using Django & Tailwind CSS.
- Host: GitHub
- URL: https://github.com/mohitbharambe/reel-rec
- Owner: MohitBharambe
- License: mit
- Created: 2025-01-10T09:28:11.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-02-07T06:07:00.000Z (4 months ago)
- Last Synced: 2025-02-07T06:26:25.715Z (4 months ago)
- Topics: btech-project, collaborate, content-based-recommendation, django-project, final-year-project, finalyearproject, jetbrains, machine-lear, machinelearning-python, movie-recommedation, movie-recommendation-app, python, python-project, recommendation-algorithm, recommendation-system, reel-rec, tailwindcss, webapp, webapplication
- Language: HTML
- Homepage:
- Size: 21.3 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- Contributing: contributing.md
- License: LICENSE
Awesome Lists containing this project
README
# Reel Rec
### Reel Rec - A Movie Recommendation AI designed to change the way movie enthusiasts discover and enjoy favorite films.
## Table of Contents
- [Overview](#overview)
- [Requirement Specifications/Tech Stack](#requirement-specifications--tech-stack)
- [Installation](#installation)
- [Screenshots](#screenshots)
- [Usage](#usage)
- [License](#license)
- [Attributions](#attributions)
- [Planned Future Updates](#planned-future-updates)
- [Contributing](#contributing)
- [Contact](#contact)
# Overview
Reel Rec is a content-based recommendation AI developed as a web application using
Django & Tailwind CSS for smooth user experience. Users also signup and receive movie recommendations by simply selecting a movie they're familiar with without restrictions on genre, actor, release date, or film industry & receive Personalized Recommendations. After receiving the recommendations, users have the option to view movie details, watch the trailer through YouTube.
## Requirement Specifications / Tech Stack
- Languages: [**Python**](https://www.python.org/downloads/), [**Javascript**](https://developer.mozilla.org/en-US/docs/Web/JavaScript)
- Frameworks: [**Tailwind CSS**](https://tailwindcss.com/docs/installation/play-cdn) & [**Django**](https://www.djangoproject.com/)
- Database: [**MySQL**](https://dev.mysql.com/downloads/)
- Libraries: [**Barba JS**](https://barba.js.org/docs/getstarted/install/) & [**GSAP**](https://gsap.com/docs/v3/Installation)
- API: [**TMDB API**](https://developer.themoviedb.org/reference/intro/getting-started)
## Installation
#### There are two ways to setup Reel-Rec on your local machine.
### 1. Easy Install using Batch Script [*Windows only*] (**Recommended**)
1. Clone the repository:
```sh
git clone https://github.com/MohitBharambe/Reel-Rec.git
```
2. Run the following commands in the terminal:
```sh
cd Reel-Rec
install.bat
```
3. The Script will automatically create a virtual environment, install the required dependencies & start the app.
### 2. Manual Installation [*Windows, MacOS, Linux*]
1. Clone the repository:
```sh
git clone https://github.com/MohitBharambe/Reel-Rec.git
cd Reel-Rec
```
2. Create & Activate a Virtual Environment (optional):
```sh
python -m venv env # Create
source env/bin/activate # for MACOS
env\Scripts\activate # for Windows
```
3. Install the requirements:
```sh
pip install -r requirements.txt
```
4. In MySQL Shell, Create a database named `reel_rec`:
```sql
create database reel_rec;
```
5. Create a `.env` file at the root level of the directory with the following variables and assign the respective values:
```python
SECRET_KEY=
MYSQL_USER=
MYSQL_PASSWORD=
bearer_token=
```
6. Inside the `Models` directory Run the `algorithm.ipynb` file Using Jupyter Notebook to generate the Model's files.
7. Perform migrations:
```sh
python manage.py makemigrations
python manage.py migrate
```
8. Create a Admin User(optional):
```sh
python manage.py createsuperuser
```
9. Run the server:
```sh
python manage.py runserver
```
10. If the shell output is Similar to the one below , The app can now be accessed at `http://127.0.0.1:8000`
```sh
Watching for file changes with StatReloader
Performing system checks...
System check identified no issues (0 silenced).
December 10, 2024 - 15:44:16
Django version 5.1.4, using settings 'Reel_Rec.settings'
Starting development server at http://127.0.0.1:8000/
Quit the server with CTRL-BREAK.
```
## Screenshots
### 1 - Select familiar Movies
### 2 - Get Recommendations
### FAQ Page
## Usage
## License
This project is licensed under the MIT License. See the [``LICENSE``](https://github.com/MohitBharambe/Reel-Rec/blob/a6a15674b7f740ce16c025ded38cdd61bd155bf2/LICENSE) file for more details.
## Attributions
This product uses the TMDB API but is not endorsed or certified by TMDB.
- [TMDB API](https://developer.themoviedb.org/reference/intro/getting-started)
- [Dataset Used ](https://www.kaggle.com/datasets/ahsanaseer/top-rated-tmdb-movies-10k)
## Planned Future Updates
- Get Recommendations based on User's Mood.
- Add a feature to save favorite movies.
## Contributing
Thank you for considering contributing to Reel Rec! refer the [``contributing.md``](https://github.com/MohitBharambe/Reel-Rec/blob/a6a15674b7f740ce16c025ded38cdd61bd155bf2/contributing.md) file for making a contribution.
## Contact
- Github:
https://github.com/MohitBharambe
- Email Address: