Library Management System

Library management system written in Django and Django REST Framework.

Installation

Clone the Repository

git clone https://github.com/your_username/library_management.git
cd library_management
python -m venv venv
source venv/bin/activate
pip install -r requirements.txt

Setup Database

export DB_HOST=<your_db_hostname>
export DB_NAME=<your_db_name>
export DB_USER=<your_db_username>
export DB_PASSWORD=<your_db_password>
python manage.py makemigrations
python manage.py migrate
python manage.py runserver
python manage.py createsuperuser

Getting access

To access the API endpoints, follow these steps:

1. Go to one of the following URLs:

   • Register user
   • Obtain Bearer token

2. Type in your Email & Password. For example:

   • Email address: [email protected]
   • Password: 12345678

3. After submitting your credentials, you will receive a token. This token grants access to the API endpoints.

Available Endpoints For Users App

You can use the following endpoints:

• Refresh Token - This URL will refresh your token when it expires.
• Verify Token - This URL will verify if your token is valid and has not expired.
• User Details - This URL will display information about yourself using the token assigned to your user.

Please note that accessing certain endpoints may require the ModHeader extension, which is available for installation in Chrome.

That's it for user endpoints. You can now proceed to the next step.

Getting Started With DRF Library Management API

• Go to the URL provided: API Books Endpoint. This URL provides authors & books creation.
• Go to the next URL provided: API Borrowings Endpoint. This URL borrowings creation.
• Go to the next URL provided: API Borrowings Endpoint. This URL borrowings list.
• Go to the next URL provided: API Borrowings Endpoint. This URL provides borrowings return.

Now you are ready to use the API to manage your library. Have fun!

Features

• JWT authenticated
• Admin panel available at /admin/
• Documentation located at /api/doc/swagger/
• Manage books with authors
• Create borrowings & return them, card payments implemented
• Implemented telegram bot with borrowing notifications
• Implemented Celery task to check borrowings overdue
• Implemented filtering in Swagger