sunilnp2/lms-docker-compose

library-management-drf With Docker Containerization

This Django REST Framework (DRF) project manages a library system with features like registration, authentication book listing, borrowing, and returning. with complete unit testing of models, serializers, and using Docker Containerization.

Table of Contents

• Getting Started
  • Prerequisites
  • Installation
  • Running the Server
• API Documentation
  • Endpoint 1: Signup
  • Endpoint 1: Get All User
  • Endpoint 1: Login
  • Endpoint 1: List All Books
  • Endpoint 2: Borrow Book
  • Endpoint 3: Return Borrowed Book

Getting Started

Prerequisites

Make sure you have the following tools installed:

• Python (>=3.x)
• Django
• Django REST Framework
• Docker
• Docker Compose

Installation

1. Clone the repository:

   git clone https://github.com/sunilnp2/library-management-drf.git
   cd library-management-drf
   

2. Run Docker Service:

   docker compose build
   

3. Run docker-compose Services

     docker compose up -d
   

4. Open Web interactive terminal (-it):

   docker exec -it lms-container bash
   
   Migrate
   python manage.py makemigrations
   python manage.py migrate
   

5. Create Superuser:

   python manage.py createsuperuser    
   test@gmail.com
   test123

6. Open PostgreSQL interactive terminal

     docker exec -it postgres_db psql -U postgres
   

The API will be accessible at http://localhost:8000

API Documentation

API Endpoint: Create a New User

• URL: http://localhost:8000/auth/api/signup/

• Method: POST

• Authentication: No Auth

• Data:

  {
    "name": "Sunil Nepali",
    "email": "sunil@gmail.com",
    "password": "test123"
    "password2": "test123"
  }
  

API Endpoint: Login

• URL: http://localhost:8000/auth/api/login/

• Method: POST

• Authentication: No Auth

• Data:

  {
  "email": "sunil@gmail.com",
  "password": "test123"
  }
  

API Endpoint: Get All User

• URL: http://localhost:8000/auth/api/getalluser/
• Method: Get
• Authentication: No Auth

API Endpoint: Get Specific User User

• URL: http://localhost:8000/auth/api/getuser/id/
• Method: Get
• Authentication: No Auth

API Endpoint: Create a New Book

• URL: http://localhost:8000/library/api/book_all_create/

• Method: POST

• Authentication: Basic Authentication

• Permissions: CustomPermission - (IsAuthenticatedOrReadOnly)

• Data:

  {
    "title": "Rich Dad Poor Dad",
    "isbn": "4354",
    "published_date": "2020-040-23"
    "genre": "finance"
  }
  

API Endpoint: Get All Books

• URL: http://localhost:8000/library/api/book_all_create/
• Method: Get
• Authentication: No Auth

API Endpoint: Get Specific Books

• URL: http://localhost:8000/library/api/book/id
• Method: Get
• Authentication: No Auth

API Endpoint: Create a Book Detail

• URL: http://localhost:8000/library/api/create-book-detail/

• Method: POST

• Authentication: Basic Auth

• Permissions: CustomPermission - (IsAuthenticatedOrReadOnly)

• Data:

  {
    "book": 1,
    "number_of_pages": 330,
    "publisher": "Asmita Publication",
    "language": "english"
  }
  

API Endpoint: Update Book Detail

• URL: http://localhost:8000/library/api/book-detail/id/

• Method: Patch

• Authentication: Basic Auth

• Permissions: CustomPermission - (IsAuthenticatedOrReadOnly)

• Data:

  {
    "number_of_pages": 400,
  }
  
  

API Endpoint: Borrow Book

• URL: http://localhost:8000/library/api/borrowbook/

• Method: POST

• Authentication: Basic Auth

• Permissions: CustomPermission - (IsAuthenticatedOrReadOnly)

• Data:

  {
    "user": 1, 
    "book": 1,
  }
  
  

API Endpoint: List Borrowed Books

• URL: http://localhost:8000/library/api/list_borrowed_book/
• Method: Get
• Authentication: Basic Auth
• Permissions: CustomPermission - (IsAuthenticatedOrReadOnly)

API Endpoint: Return Borrowed Book

• URL: http://localhost:8000/library/api/return-book/id/

• Method: Put

• Authentication: Basic Auth

• Permissions: CustomPermission - (IsAuthenticatedOrReadOnly)

• Data:

  {
    "returned_date": "2024-02-01"
  }