Skip to content

Repository files navigation

Readify

Landing page screenshot Home page screenshot

Welcome to Readify, a book tracking web application that allows you to manage your book collection effortlessly. With Readify, you can search for books, manually add them, and keep track of your reading list. The application is built using Flask for the backend and React for the frontend, providing a seamless and interactive user experience.

Table of Contents

Features

  • Search and Add Books: Search for books and add them to your collection.
  • Manual Entry: Add books manually by filling in the title, authors, description, and image.
  • User Profile: Manage your profile details, including updating your bio, password, and profile image.
  • BookList: View your entire book collection and search through it.

Getting Started

Prerequisites

  • Node.js version 18 (for the frontend)
  • Python 3.x (for the backend)
  • Flask and React libraries

Installation

  1. Clone the Repository:

    git clone https://github.com/Zeezbaba/Readify.git
    cd Readify
  2. Install Backend Dependencies:

    Navigate to the backend folder and install the Python dependencies.

    cd backend
    python3 -m venv venv
    source venv/bin/activate
    pip install -r requirements.txt
  3. Install Frontend Dependencies:

    Navigate to the frontend folder and install the Node.js dependencies.

    cd ../frontend
    npm install

Running the Application

  1. Run the Backend:

    In the backend directory, start the Flask server.

    flask run
  2. Run the Frontend:

    In the frontend directory, start the React development server.

    npm start
  3. Access the Application:

    Open your browser and navigate to http://localhost:3000 to access the application.

Pages Overview

Add Books Page

This page allows users to search for books via the OpenLibrary API and add them to their collection. It also includes a manual entry section for adding books by entering the title, author(s), description, and image URL.

Add Books Page Screenshot

BookList Page

The BookList page displays all books added to the user's collection.

BookList Page Screenshot

About

A Book Tracking Digital Application

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages