Library Management System

Overview

Welcome to our Library Management System API Web Application! This web application is designed to streamline the management of library resources, providing a comprehensive set of endpoints to handle various book-related operations. Whether you're adding new books, deleting outdated entries, searching for specific titles, or updating existing details, our API has you covered.

Table of Contents

• Library Management System API
  • Overview
  • Table of Contents
  • Description
  • Key Features
  • How to Use
  • Backend
    • Documentation
      • Built With
      • Setup
        • Requirements
        • Activate the virtual environment
        • Database Configuration
        • Running the Application
      • API Endpoints
        • Welcome
        • Status
        • Statistics
        • Book Endpoints
          • Add a Book
          • Delete a Book
          • Search Books
          • List All Books
          • List Books by Category
          • Update a Book
        • User Endpoints
          • Error Handling
        • User Endpoints
          • Add User
          • Login User
          • Logout User
• Frontend
  • Documentation
    • fetchRequest Function
    • createLi Function
    • createLis Function
    • displayBooky Function
    • listAllBooks Function
    • listBooksByCategory Function
    • insertBook Function
    • deleteBook Function
    • updateBook Function
    • searchBooks Function
    • listBooksBySelectedCategory Function
    • formInput Function
    • displayBooks Function
    • updatesearch Function
    • Usage

Description

This web application is designed to streamline the management of library resources, providing a comprehensive set of endpoints to handle various book-related operations. Whether you're adding new books, deleting outdated entries, searching for specific titles, or updating existing details, our API has you covered.

Key Features:

1. Book Management:
   Adding Books: Easily insert new books into the library database, ensuring accurate and up-to-date information.
   Deleting Books: Remove outdated or unnecessary books from the library inventory with a simple deletion process.
   Searching Books: Efficiently search for specific titles or topics within the library's extensive collection.
   Updating Book Details: Keep book information current by updating details such as title, author, genre, and more.

2. Library Statistics:
   Total Number of Books: Retrieve insights into the overall size of the library collection.
   Categories: Explore the diverse range of book genres available in the library.
   User Counts: Obtain statistics on library usage, including user counts for a better understanding of engagement.

How to Use:

1. List All Books: Call listAllBooks('all-books') to display a comprehensive list of all available books on page load.

2. Manage Books by Category: Utilize listBooksByCategory to fetch and display books based on specific categories.

3. Insert New Books: Add fresh additions to the library by employing the insertBook function.

4. Delete Books: Remove unwanted or obsolete books using the deleteBook function.

5. Update Book Information: Keep book details accurate with the updateBook function.

6. Search for Books: Use the searchBooks function to perform searches based on your specific criteria.

7. List Books by Selected Category: Enhance user experience by implementing listBooksBySelectedCategory to filter books by a chosen category.

8. Explore Library Statistics: Dive into the library's statistical insights, including the total number of books, categories, and user counts.

Backend

The backend of the application is built using Python, Flask, and MySQL. The Flask application is configured to connect to a MySQL database, which stores information about the books in the library. The application provides a set of endpoints to perform various operations on the database, including adding, deleting, updating, and searching for books. The application also provides endpoints to retrieve statistics about the library, such as the total number of books, categories, and user counts.

Documentation

The backend documentation provides an overview of the backend code for a library management system. The code includes functions for connecting to the database, creating API endpoints, and performing various operations on the database.

Directory: Backend

Built With

• Python
• Flask
• MySQL
• Bootstrap
• fetch API
• JavaScript
• HTML
• CSS
• dotenv

Setup

Requirements

Make sure you have Python installed on your system. Then, create and activate a virtual environment.

Create a virtual environment

python -m venv venv

Activate the virtual environment

On Windows

venv\Scripts\activate

On macOS/Linux

source venv/bin/activate

Install the required Python packages using the provided requirements.txt file:

pip install -r requirements.txt

Database Configuration

Set up your MySQL database by configuring the environment variables in a .env file.
Specify the database user, password, host, name, and the default route.

DATABASE_USER=your_database_user
DATABASE_PASSWORD=your_database_password
DATABASE_HOST=your_database_host
DATABASE_NAME=your_database_name
ROUTE_DEFAULT=/api/v1

Running the Application

Run the Flask application using the following command:

python app.py or flask run

The application will be accessible at http://127.0.0.1:5000/ by default.

API Endpoints

Welcome

• Route: /api/v1
• Method: GET
• Description: Welcome message for the books library system.

Example Response:

{
    "success": true,
    "status": 200,
    "message": "Welcome to the books library system"
}

Status

• Route: /api/v1/status
• Method: GET
• Description: Returns a status message confirming that the application is running.

Example Response:

{
  "success": true,
  "status": 200,
  "message": [
    {"request": true, "response": true},
    {"Header1": "Value1", "Header2": "Value2"}
  ]
}

Statistics

• Route: /api/v1/stats
• Method: GET
• Description: Returns statistics of the library management system.

Example Response:

{
  "success": true,
  "status": 200,
  "message": [
    {
      "book": [
        {
          "total": 50,
          "countByCategories": 5,
          "categories": ["Fiction", "Non-Fiction"]
        }
      ]
    },
    {
      "user": [
        {
          "total": 100,
          "verified": 80,
          "unverified": 20
        }
      ]
    }
  ]
}

Book Endpoints

Add a Book

• Route: /api/v1/insert
• Method: POST
• Description: Adds a book to the library.

Example Request:

{
  "title": "Sample Book",
  "author": "John Doe",
  "genre": "Fiction",
  "isbn": "1234567890",
  "year": 2022,
  "synopsis": "A sample book synopsis.",
  "copiesAvailable": 10
}

Example Response:

    {
      "success": true,
      "status": 201,
      "message": "The book has been added to the Library"
    }

Delete a Book

• Route: /api/v1/delete
• Method: DELETE
• Description: Deletes a book from the library.
• Example Request:

{
  "isbnOrTitle": "1234567890"
}

Example Response:

    {
      "success": true,
      "status": 201,
      "message": "The book has been deleted"
    }

Search Books

• Route: /api/v1/search
• Method: GET
• Description: Searches for books in the library based on a query.
• Query Parameters: query=Search term

Example Response:

    {
      "success": true,
      "status": 200,
      "message": [
        {
          "id": 1,
          "title": "Sample Book",
          "author": "John Doe",
          "genre": "Fiction",
          "isbn": "1234567890",
          "year": "2022",
          "synopsis": "A sample book synopsis.",
          "copiesAvailable": 10,
          "dateAdded": "2022-01-01T12:00:00",
          "dateModified": "2022-01-01T12:00:00"
        }
      ],
      "count": 1
    }

List All Books

• Route: /api/v1/list
• Method: GET
• Description: Retrieves a list of all books from the library.

Example Response:

    {
      "success": true,
      "status": 200,
      "message": [
        {
          "id": 1,
          "title": "Sample Book",
          "author": "John Doe",
          "genre": "Fiction",
          "isbn": "1234567890",
          "year": "2022",
          "synopsis": "A sample book synopsis.",
          "copiesAvailable": 10,
          "dateAdded": "2022-01-01T12:00:00",
          "dateModified": "2022-01-01T12:00:00"
        }
      ],
      "count": 1
    }

List Books by Category

• Route: /api/v1/list/category
• Method: GET
• Description: Retrieves a list of books based on a specific genre.
• Query Parameters: genre=Book category

Example Response:

    {
      "success": true,
      "status": 200,
      "message": [
        {
          "id": 1,
          "title": "Sample Book",
          "author": "John Doe",
          "genre": "Fiction",
          "isbn": "1234567890",
          "year": "2022",
          "synopsis": "A sample book synopsis.",
          "copiesAvailable": 10,
          "dateAdded": "2022-01-01T12:00:00",
          "dateModified": "2022-01-01T12:00:00"
        }
      ],
      "count": 1
    }

Update a Book

• Route: /api/v1/update
• Method: PUT
• Description: Updates the details of a book in the library.

Example Request:

{
  "title": "Updated Sample Book",
  "author": "John Doe",
  "genre": "Fiction",
  "isbn": "1234567890",
  "year": 2023,
  "synopsis": "An updated sample book synopsis.",
  "copiesAvailable": 5
}

Example Response:

{
      "success": true,
      "status": 201,
      "message": "The book has been updated in the Library"
}

Error Endpoints

Error Handling

• Description: 404 Not Found

{
  "success": false,
  "status": 404,
  "message": "Resource Not Found"
}

User Endpoints

Add User

• Route: /api/v1/register
• Method: POST
• Description: Adds a user to the database.

Example Request:

{
		"confirmed": false,
		"confirmedOn": "Tue, 12 Dec 2023 14:22:36 GMT",
		"dateCreated": "Sun, 10 Dec 2023 10:53:06 GMT",
		"dateModified": "Tue, 12 Dec 2023 14:22:36 GMT",
		"emailAddress": "xxxx@xxx.com",
		"firstName": "Jhon",
		"id": "692d0248fe3f40dda061e34f45e41b04",
		"lastName": "Doe",
		"location": "",
		"middleName": "B",
		"phoneNumber": "000-0XX-XXX-XXX",
		"photos": null,
		"role": "user",
		"status": "inactive",
		"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3MDI0NzczNTgsImlhdCI6MTcwMjM5MDk1OCwic3ViIjoiYnVnZW1hcnZpbkBvdXRsb29rLmNvbSJ9.mJp0HLS-u66s672qDGZmxjZmkiV92Ld-nRPoxZomnis"
	}

Example Response:

    {
      "success": true,
      "status": 201,
      "message": "User created successfully"
    }

Login User

• Route: /api/v1/login
• Method: GET
• Description: Login a user

Authorization: Bearer <token>

Example Request:

{
  "username": "emailAddress | phoneNumber",
  "password": "password"
}

Example Response

{
  "sucess": true,
  "status": 200,
  "message": "User logged in successfully",
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3MDI0NzczNTgsImlhdCI6MTcwMjM5MDk1OCwic3ViIjoiYnVnZW1hcnZpbkBvdXRsb29rLmNvbSJ9.mJp0HLS-u66s672qDGZmxjZmkiV92Ld-nRPoxZomnis"
}

Logout User

• Route: /api/v1/logout
• Method: GET
• Description: Login a user

Example Response

{
  "sucess": true,
  "status": 200,
  "message": "User logged out successfully",
}

Frontend

The frontend of the application is built using HTML, CSS, and JavaScript. The frontend code is designed to test and interact with the backend API from the Flask server, making fetch requests to the API endpoints to perform various operations on the library database. The frontend code also provides functions to display the results of the fetch requests in the browser.

Documentation

The frontend documentation provides an overview of the frontend code for a library management system. The code includes functions for making fetch requests, creating and displaying list items, managing books, and interacting with a Flask server.

Directory: Frontend

fetchRequest Function

This function makes a fetch request to the specified API endpoint with the given request type and JSON data.

      Parameters:
        path (string): The path for the API endpoint.
        ReqType (string): The request type (e.g., GET, POST, PUT, DELETE).
        jsonData (Object): The JSON data to be sent with the request.

      Returns:
        A Promise that resolves with the response data or rejects with an error.

createLi Function

This function creates a list item and appends it to the specified element.

    Parameters:
        id (string): The id of the element to append the list item to.
        data (string): The text content of the list item.

    Returns:
        The appended list item element.

createLis Function

This function creates an HTML li element with information about a book.

    Parameters:
        data (Object): The data object containing book information.

    Returns:
        The created li element.

displayBooky Function

This function displays a list of books in the specified container element.

    Parameters:
        id (string): The ID of the container element.
        books (Array): An array of book objects.

listAllBooks Function

This function fetches and displays all books.

    Parameters:
        all (HTMLElement): The container element to display the books.

    Returns:
        A Promise that resolves with the response from the server.

listBooksByCategory Function

This function fetches and displays books by category.

    Parameters:
        category (string): The category of books to fetch.
        id (string): The ID of the element to display the books in.

    Returns:
        A Promise that resolves with the response from the server.

insertBook Function

This function inserts a book into the library management system.

    Returns:
        A Promise that resolves with the response from the server in JSON format.

deleteBook Function

This function deletes a book from the library management system.

    Returns:
        A Promise that resolves with the response from the server.

updateBook Function

This function updates a book in the library management system.

    Returns:
        A Promise that resolves with the response from the server.

searchBooks Function

This function performs a search for books based on the provided search query.

    Returns:
        A Promise that resolves with the response from the server.

listBooksBySelectedCategory Function

This function lists books by the selected category.

    Returns:
        A Promise that resolves with the response from the server.

formInput Function

This function generates a form input element with pre-filled values based on the provided data.

    Parameters:
        data (Object): The data object containing the values for the form input fields.

    Returns:
        The generated form input element.

displayBooks Function

This function displays a list of books in the specified container element.

    Parameters:
        id (string): The ID of the container element.
        books (Array): An array of book objects.

updatesearch Function

This function updates the search results based on the provided search query.

    Returns:
        A Promise that resolves with the response from the server.

Usage

• Call listAllBooks('all-books') to display all books on page load.
• Use other functions like listBooksByCategory, insertBook, deleteBook, updateBook, searchBooks, and listBooksBySelectedCategory to interact with the library management system.