Book Management System

Simple CRUD API for a book management system using Django

Table of Contents

• Manual Setup Guide
• Docker Containerization
• Book Management API

Setup Guide

Prerequisites

Ensure you have the following installed:

• Python (Python 3.x)
• Pip (Python package installer)
• Git (version control system)

Setup Steps

1. Clone the Project Repository:

   git clone https://github.com/Ghoul072/Book-Management-System
   cd Book-Management-System

2. Create a Virtual Environment (Optional but Recommended):

   python -m venv venv_name

3. Activate the virtual environment:

   # On Windows
   venv_name\Scripts\activate
   
   # On macOS / Linux
   source venv_name/bin/activate
   

4. Install Project Dependencies:

   pip install -r requirements.txt

5. Navigate to the book_management_system folder

    cd book_management_system

6. Database Setup (Assuming SQLite for simplicity):

   python manage.py makemigrations
   python manage.py migrate

7. Create Superuser (For Django Admin Access):

   python manage.py createsuperuser
   # Follow the prompt to set username, email, and password

8. Run Tests:

   python manage.py test

9. Add your hostname to Allowed Hosts If you're using any hostnames other than localhost and 127.0.0.1, make sure to add your hostname to the ALLOWED_HOSTS list in book_management_system\book_management_system\settings.py

10. Run the Django Development Server:

    python manage.py runserver

11. Access the Application: Open a web browser and go to http://127.0.0.1:8000/ to view your application.

    • Use the /admin/ route to access the Django admin panel and log in with the superuser credentials you created.
    • Use the below API Guide to make use of the Book Management API

Docker Containerization

This Django application has Docker support included. You can utilize Docker to containerize the application for easier deployment.

Prerequisites

1. Docker Installation: Ensure Docker is installed and running on your machine. You can download and install docker here

2. Environment Configuration:

   • If you're using any hostnames other than localhost and 127.0.0.1, make sure to add your hostname to the ALLOWED_HOSTS list in book_management_system\book_management_system\settings.py

Building and Running the Containers

1. Build the Docker Image: Run the following command in the terminal where the Dockerfile is located:

   docker build -t book-management-system .

2. Run the Docker Container: Start the container using the docker-compose file:

   docker-compose up

   Or, if you prefer to run the container directly:

   docker run -p 8000:8000 book-management-system

3. Access the Application: Once the container is up and running, access the Django application via a web browser using http://127.0.0.1:8000/ or http://localhost:8000/.

Book Management API

Authentication

This API uses JSON Web Token (JWT) authentication. To authenticate and receive a token, use the following endpoints:

• POST api/token/: Obtain a JWT token by providing valid credentials (username and password). This token will be valid for 1 hour.
• POST api/token/refresh/: Refresh the JWT token by providing a valid refresh token. The refresh token is valid for 1 day.

# Get access token and refresh token by authentication
curl -X POST -d "username=<username>&password=<passsword>" http://yourapi.com/api/token/

# Get access token by providing refresh token
curl -X POST -d "refresh=<your_refresh_token>" http://yourapi.com/api/token/refresh/

Endpoints

Books

Get All Books

• URL: /books/
• Method: GET
• Description: Retrieve a paginated list of all books.
• Authentication: Token-based authentication required.
• Request Parameters:
  • page: Page number for pagination (default is 1).
• Response: Returns a paginated list of books.

Example:

Request (Curl):

curl -X GET -H "Authorization: Bearer <token>" http://yourapi.com/api/books/?page=1

Response (200 OK - JSON):

{
    "count": 10,
    "next": "http://yourapi.com/api/books/?page=2",
    "previous": null,
    "results": [
        {
            "id": 1,
            "title": "Book Title 1",
            "author": "Author Name",
            "publicationYear": 2005,
            "genre": "Fiction"
        },
        {
            "id": 2,
            "title": "Yet Another Book, and so on",
            "author": "Author Name",
            "publicationYear": 2020,
            "genre": "Fiction"
        },
    ]
}

Add a New Book

• URL: /books/
• Method: POST
• Description: Add a new book to the library.
• Authentication: Token-based authentication required.
• Request Body (JSON):

  {
      "title": "New Book Title",
      "author": "New Author",
      "publicationYear": 2022,
      "genre": "Sci-Fi"
  }

• Response: Returns the details of the newly created book.

Example:

Request (Curl):

curl -X POST -H "Authorization: Bearer <token>" -d '{"title": "New Book Title", "author": "New Author", "publicationYear": 2022, "genre": "Sci-Fi"}' -H "Content-Type: application/json" http://yourapi.com/api/books/

Response (201 Created - JSON):

{
    "id": 101,
    "title": "New Book Title",
    "author": "New Author",
    "publicationYear": 2022,
    "genre": "Sci-Fi"
}

Get a Book by ID

• URL: /books/<int:pk>/
• Method: GET
• Description: Retrieve details of a specific book by its ID.
• Authentication: Token-based authentication required.
• Response: Returns details of the book.

Example:

Request (Curl):

curl -X GET -H "Authorization: Bearer <token>" http://yourapi.com/api/books/1/

Response (200 OK - JSON):

{
    "id": 1,
    "title": "Book Title 1",
    "author": "Author Name",
    "publicationYear": 2005,
    "genre": "Fiction"
}

Update a Book by ID

• URL: /books/<int:pk>/
• Method: PUT
• Description: Update details of a specific book by its ID.
• Authentication: Token-based authentication required.
• Request Body (JSON):

  {
      "title": "Updated Book Title",
      "author": "Updated Author",
      "publicationYear": 2023,
      "genre": "Updated Genre"
  }

• Response: Returns details of the updated book.

Example:

Request (Curl):

curl -X PUT -H "Authorization: Bearer <token>" -d '{"title": "Updated Book Title", "author": "Updated Author", "publicationYear": 2023, "genre": "Updated Genre"}' -H "Content-Type: application/json" http://yourapi.com/api/books/1/

Response (200 OK - JSON):

{
    "id": 1,
    "title": "Updated Book Title",
    "author": "Updated Author",
    "publicationYear": 2023,
    "genre": "Updated Genre"
}

Delete a Book by ID

• URL: /books/<int:pk>/
• Method: DELETE
• Description: Delete a specific book by its ID.
• Authentication: Token-based authentication required.
• Response: Returns a success message on deletion.

Example:

Request (Curl):

curl -X DELETE -H "Authorization: Bearer <token>" http://yourapi.com/api/books/1/

Response (204 No Content):

No content returned for a successful deletion.