Giter VIP home page Giter VIP logo

thirdyearproject's Introduction

Book Recommendation and Search API

Overview

This project aims to provide a book recommendation and search API along with a demo app. The API utilizes datasets from Goodbooks-10k-Extended, Libgen database dumps, and the Sri Lanka National Bibliography. The demo app serves as a frontend for interacting with the API and exploring book recommendations.

Features

  • Book recommendation based on user preferences
  • Book search functionality
  • Demo app for visualizing recommendations

Dependencies

  • Flask: Used to run the API server
  • Next.js: Used to run the demo app
  • Scikit-learn: Used for building recommender models
  • Google BART: Used for advanced recommendation techniques

Installation

To install and set up the project locally, follow the instructions provided in the README.md files located in the api and demo-app directories within the src folder.

Usage

  • Start the API server using Flask by following the instructions in the api/README.md file.
  • Run the demo app using Next.js by following the instructions in the demo-app/README.md file.
  • Interact with the API endpoints to get book recommendations and search for books.

Documentation

For detailed project documentation, including the project report and other relevant details, refer to the docs folder.

Testing

Due to time constraints, testing was kept minimal. However, you can run basic tests as described in the api/README.md file.

Acknowledgments

We would like to acknowledge the University of Vavuniya, Faculty of Applied Science, and in particular, Dr. S. Kirushanth for his patience and understanding throughout the project.

Contact

For any questions or feedback, please contact the project maintainers:

  • Mithini Rathnayake (2019/ICT/24)
  • S.G. Seyone (2019/ICT/46)
  • Charitha Dilman (2019/ICT/64)
  • Tharushi Nimnadi (2019/ICT/66)
  • Ashma Sandeepa (2019/ICT/85)
  • Sonali Kalpani (2019/ICT/108)
  • Ihsana (2019/ICT/35)
  • Zeema (2019/ICT/98)

thirdyearproject's People

Contributors

seyone22 avatar mgsk-j avatar mithini avatar viethushaa avatar charithadilman avatar zeenanavavi avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.