Skip to content

Commit 98f7cd0

Browse files
committed
updated readme
1 parent 137dd4a commit 98f7cd0

File tree

3 files changed

+60
-15
lines changed

3 files changed

+60
-15
lines changed

Readme.md

Lines changed: 60 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,80 @@
1-
# Movie-Recommender-System
2-
Django based movie recommendation system using collaborative filtering technique.
1+
# Django based music streaming website
2+
> https://galvanic-music.herokuapp.com/
33
4-
## Deployed webapp
5-
> https://awesome-movie-recommender.herokuapp.com/
4+
![GitHub stars](https://img.shields.io/github/stars/rajaprerak/movie_recommender)
5+
[![Maintenance](https://img.shields.io/badge/maintained-yes-green.svg)](https://github.com/rajaprerak/movie_recommender/commits/master)
6+
[![Website shields.io](https://img.shields.io/badge/website-up-yellow)](https://awesome-movie-recommender.herokuapp.com/)
7+
[![License](http://img.shields.io/:license-mit-blue.svg?style=flat-square)](http://badges.mit-license.org)
68

7-
### Tech Stack
89

9-
Django, Python, HTML , CSS , JavaScript , Bootstrap , SQLite, Pandas, AWS S3, Heroku
10+
## Installation 📦
1011

12+
>pip install -r requirements.txt
1113
12-
### To run
13-
```
14-
python manage.py runserver
15-
```
16-
#### Open your browser and go to this address
17-
```
18-
http://127.0.0.1:8000
14+
#### Clone
15+
16+
- Clone this repo to your local machine.
17+
18+
#### Run server locally
19+
20+
```shell
21+
$ python manage.py runserver
1922
```
23+
> Go to localhost:8000
2024
21-
#### Web-App Functionalities
25+
---
26+
## Features 📋
2227
* User can register and login.
2328
* User can search through various movies and look through its details.
2429
* User can give rating to the movies.
2530
* User can add movie to their watch list.
2631
* User can get movie recommendation (Recommendation algorithm (Collaborative Filtering) which suggests new movies based on the ratings given by user.)
32+
---
2733

34+
## Algorithm
2835
##### Collabortive Filtering (Recommender Algorithm)
2936
* Collaborative filtering filters information by using the interactions and data collected by the system from other users. It's based on the idea that people who agreed in their evaluation of certain items are likely to agree again in the future.
3037
* When we want to find a new movie to watch we'll often ask our friends for recommendations. Naturally, we have greater trust in the recommendations from friends who share tastes similar to our own.
3138
* Collaborative-filtering systems focus on the relationship between users and items. The similarity of items is determined by the similarity of the ratings of those items by the users who have rated both items.
3239
* There are two types of collaborative filtering
3340
* **User-based**, which measures the similarity between target users and other users.
3441
* **Item-based**, which measures the similarity between the items that target users rate or interact with and other items.
35-
> I have used **user based** collaborative filtering in this project.
42+
> I have used **user based** collaborative filtering in this project.
43+
44+
45+
---
46+
47+
## Contributing 💡
48+
49+
50+
#### Step 1
51+
52+
- **Option 1**
53+
- 🍴 Fork this repo!
54+
55+
- **Option 2**
56+
- 👯 Clone this repo to your local machine.
57+
58+
59+
#### Step 2
60+
61+
- **Build your code** 🔨🔨🔨
62+
63+
#### Step 3
64+
65+
- 🔃 Create a new pull request.
66+
67+
## Team ✨
68+
69+
| <a href="https://rajaprerak.github.io" target="_blank">**Prerak Raja**</a>
70+
| :---: |
71+
| [![Prerak Raja](https://github.com/rajaprerak.png?size=100)](https://rajaprerak.github.io)
72+
| <a href="https://github.com/rajaprerak" target="_blank">`github.com/rajaprerak`</a>
73+
74+
75+
## License
76+
[![License](http://img.shields.io/:license-mit-blue.svg?style=flat-square)](http://badges.mit-license.org)
77+
78+
- **[MIT license](http://opensource.org/licenses/mit-license.php)**
79+
80+

website_images/DetailPage.png

138 KB
Loading

website_images/HomePage.png

524 KB
Loading

0 commit comments

Comments
 (0)