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.
- Book recommendation based on user preferences
- Book search functionality
- Demo app for visualizing recommendations
- 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
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.
- 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.
For detailed project documentation, including the project report and other relevant details, refer to the docs
folder.
Due to time constraints, testing was kept minimal. However, you can run basic tests as described in the api/README.md
file.
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.
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)