Skip to content

HKanoje/book-recommendation-system

Repository files navigation

Book Recommendation System

A semantic book recommendation system that suggests books based on natural language queries, categories, and emotional tones.

Dashboard Preview

DashBoard

Table of Contents 📑

Installation & Setup 🚀

There are two ways to run this application:

1. Local Installation

  1. Clone the repository

    git clone <your-repository-url>
    cd <repository-name>
  2. Create and activate virtual environment

    python -m venv venv
    
    # On Windows
    .\venv\Scripts\activate
    
    # On Unix or MacOS
    source venv/bin/activate
  3. Install dependencies

    pip install -r requirements.txt
  4. Set up environment variables

    • Create a .env file in the root directory
    • Add your OpenAI API key:
      OPENAI_API_KEY=your_api_key_here
  5. Run the application

    python gradio-dashboard.py
  6. Access the application

    • Open your browser and navigate to http://localhost:7860

2. Docker Installation

  1. Clone the repository

    git clone <your-repository-url>
    cd <repository-name>
  2. Set up environment variables

    • Create a .env file in the root directory
    • Add your OpenAI API key:
      OPENAI_API_KEY=your_api_key_here
  3. Build Docker image

    docker build -t book-recommendation-system .
  4. Run Docker container

    docker run -p 7860:7860 book-recommendation-system
  5. Access the application

    • Open your browser and navigate to http://localhost:7860

Usage 📚

  1. Enter a description of the type of book you're looking for
  2. Select a category (optional)
  3. Choose an emotional tone (optional)
  4. Click "Find recommendations" to get personalized book suggestions

Features ✨

  • 🔍 Semantic search using OpenAI embeddings
  • 📚 Category-based filtering
  • 😊 Emotional tone sorting
  • 🖼️ Book cover gallery display
  • ✍️ Author and description preview

Technologies Used 🛠️

  • Python
  • Gradio
  • LangChain
  • OpenAI Embeddings
  • ChromaDB
  • Docker

Made with ❤️ for book lovers

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages