Skip to content

API service for library management written on DRF

Notifications You must be signed in to change notification settings

KittNeKit/BookWise

Repository files navigation

BookWise

API service for library management written on DRF

Features

  • JWT authenticated
  • CRUD functionality for Books Service
  • CRUD for Users Service
  • Telegram notification!
  • Notification for admin about new borrowing or new payment paid
  • Executes everyday tasks for monitoring overdue borrowings.
  • Return book functionality
  • Automatically create a fine payment if the user returned a book after the expected return date.
  • Documentation is located at /api/doc/swagger/

Installing using GitHub:

Install PostgreSQL and create DB

  1. Clone the repository:
git clone https://github.com/your-username/library-project
  1. Change to the project's directory:
cd library-project
  1. Сopy .env_sample file with your examples of env variables to your .env file

don't forget to create your Stripe account and get your bot token in BotFather

  1. Once you're in the desired directory, run the following command to create a virtual environment:
python -m venv venv
  1. Activate the virtual environment:

On macOS and Linux:

source venv/bin/activate

On Windows:

venv\Scripts\activate
  1. Install the dependencies
pip install -r requirements.txt
  1. Set up the database:

Run the migrations

python manage.py migrate
  1. Start the development server
python manage.py runserver
  1. Access the website locally at http://localhost:8000.

Run with Docker

Docker should be installed

docker-compose build
docker-compose up

Getting access

  • get access token via /api/user/token/ by
email = [email protected]
password = user123123

or register your own user via /api/users/ and get an access token

About

API service for library management written on DRF

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published