Skip to content

Mufsh/bookify

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 

Repository files navigation

Book Management Website

This project is a book management website developed using React and Vite for the front-end and Python FastAPI for the back-end. Users can upload books, categorize them, view summaries, and manage their book collections. Summaries are generated using Llama models running locally.

Features

  • Upload Books: Users can upload books to the platform.
  • Categorize Books: Each book is automatically categorized (e.g., Fiction, Biography, Autobiography, Sports).
  • View Books: Users can view a list of all uploaded books.
  • Generate Summaries: Users can generate summaries for each book using Llama models running locally.

Installation

Front-end (React and Vite)

git clone <repository_url>
cd <repository_folder>/frontend
npm install
npm run dev

Backend (FastAPI)

Navigate to the Backend Directory:

Create and Activate a Virtual Environment:

python -m venv venv
source venv/bin/activate  # On Windows, use `venv\Scripts\activate`

Install Dependencies:

pip install -r requirements.txt

Run the FastAPI Server:

uvicorn main:app --reload

Configuration

Database Configuration

Ensure you have PostgreSQL installed and set up. Update the database URL in the FastAPI configuration file. SQLAlchemy is used to connect to the PostgreSQL database. There is a table for storing the books and their details.

OpenAI API Configuration

Ensure you have the Llama models set up locally. Update the model path in the FastAPI configuration file.

Usage

Upload Books:

  • Navigate to the upload section on the website.
  • Upload a book file.

View Books:

  • Navigate to the books section to see all uploaded books.
  • Click on a book to see its details.

Generate Summaries:

  • Select a book.
  • Click on the "Generate Summary" button to get a summary of the book.

Technologies Used

Front-end:

  • React
  • Vite
  • Tailwind CSS

Back-end:

  • FastAPI

  • OpenAI API

  • PostgreSQL

  • llama models

  • SQLAlchemy

    Screenshots

Home Page

WhatsApp Image 2024-07-05 at 4 06 45 AM

Adding a book

WhatsApp Image 2024-07-05 at 4 07 01 AM

Editing details

WhatsApp Image 2024-07-05 at 4 07 14 AM

Generating Summary

WhatsApp Image 2024-07-05 at 4 07 27 AM

Generated Summary

WhatsApp Image 2024-07-05 at 4 07 40 AM

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors