Flick Movie Recommendation System

This is the backend repository for Flick Movie Recommendation which is a content-boosted recommendation system that provides users with movie recommendations based on their past interaction with the system.

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License
6. Contact

About The Project

The aim of this project is to build a web based application that will recommend movies to users that they might want to watch.
For this a content-boosted recommendation system is implemented that make use of ratings as well as comments to weight the recommendations.

Here's why:

• The application only needs a web browser to work and can work on low-end devices.
• The application does not violet any legal requirement the user’s data is kept safe within the system as well as it does not violet any content laws.
• The application is working with an average latency of less than 100ms.

Built With

• Node.js.
• Express.js
• Mongoose
• Winston
• Pasport.js

Getting Started

Prerequisites

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/<your_username>/flick-backend.git

2. Install NPM packages

   npm install

3. Modify config/dev.js

    module.exports={
        mongourl:"<mongodb-url>",
        JWT_SECRET:"<your-secret>",
        FRONTEND_URL:"<frontend-client-url>"
    }

   Frontend Repository Recommendation System Repository

Usage

In the project directory, you can run:

   npm start

Open http://localhost:5000 to view the server documentation.

Live Demo

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b some-new-feature)
3. Commit your Changes (git commit -m 'Add some feature')
4. In case of multiple commits squash them. Refer documentation
5. Push to the Branch (git push origin some-new-feature)
6. Open a Pull Request

License

Distributed under the GNU General Public License v3.0. See LICENSE for more information.

Contact

Lakshya Bansal - lakshyabansal

Project Link: https://github.com/lakshya-20/flick-backend