DRF-Library-Group-Project

There is a library, where you can borrow books and pay for your borrowings using cash, depending on the days you read the book. There is the system with possibility of tracking books, borrowings, users & payments in the library is outdated.

Docs: /api/doc/swagger/

💼 Installing using GIT

git clone https://github.com/MikhailLyvak/DRF-Library.git
cd DRF-LIBRARY
python -m venv venv
venv\Scripts\activate (on Windows)
source venv/bin/activate (on macOS)
pip install -r requirements.txt

📝 How to enable scheduled tasks

 1. Ensure than you have installed django-q from requirements
 2. Make migrations: python manage.py migrate
 3. It’s recommended to add task via admin site (localhost + /admin/django_q/schedule/add/). 
    Func = borrowing.tasks.get_borrowings_overdue
    Otherwise, you can create it via Django shell:
    Schedule.objects.create(
       func="borrowing.tasks.get_borrowings_overdue"
       schedule_type=Schedule.MINUTES,
       minutes=1
     )
 4. Run the scheduler:
    python manage.py runserver
    python manage.py qcluster

🤟 To get access to work with api do next steps

create user via /api/users/register/
get access token via /api/users/token/

📈 How to user ModHeader

# ModHeader should be already installed
1. + MOD --> Request header
2. Put correct credentials
    2.1. Name --> Authorize ( it`s custom name )
    2.2. Value --> Bearer < Your token >

📜 Some project Features

• JWT authenticated
• Admin panel /admin/
• Documentation is located at /api/doc/swagger/
• Managing books:
  • ( for admin only )
  • ( user can only see a list of books )
• Borrowings:
  • ( user can borrow book for 1 week )
  • ( user can`t borrow book if it out of stock )
• Notifications:
  • ( when book borrowed, telegram bot send notification )
  • ( telegram bot send notifications with info about overdue books )
• Payments:
  • ( users allowed to make payments for borrowed books and fines )
  • ( users can create payments for their borrowed books or fines, and the payment service automatically generates payment session with a unique URL and ID )
  • ( users are then redirected to the payment session URL to complete the payment process )
  • ( also included, handling payment success and cancel callbacks from Stripe )
• Filtering borrowings by active borrowings (still not returned)