https://github.com/bit-web24/biblion-management-system
A simple Book Management System
https://github.com/bit-web24/biblion-management-system
fastapi oauth2 swagger-ui
Last synced: 4 months ago
JSON representation
A simple Book Management System
- Host: GitHub
- URL: https://github.com/bit-web24/biblion-management-system
- Owner: bit-web24
- Created: 2025-02-26T10:06:57.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-03-09T20:38:02.000Z (over 1 year ago)
- Last Synced: 2025-03-09T21:24:49.545Z (over 1 year ago)
- Topics: fastapi, oauth2, swagger-ui
- Language: Python
- Homepage:
- Size: 72.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# biblion-management-system
A simple Book Management System
## Prerequisites
- docker
## Build & Run
Build a docker-image from the Dockerfile.
```bash
sudo docker build -t biblion_management_system .
```
Create a container from the generated docker-image and also start it.
```bash
sudo docker run -d --name bms_container -p 8000:8000 biblion_management_system
```
## Some useful docker commands
```bash
# to stop the container
sudo docker stop
# to remove the conatiner
sudo docker rm
# to remove the app image
sudo docker rmi
```
> NOTE: A docker-image can only be deleted if there is no container using the image,
> if a container uses the image but it is in stopped state, it
> needs to be removed first in order to delete the image.
## Usage
Visit the [Documentation](http://127.0.0.1:8000/docs) to know, how:
- to create a new user.
- to Authorize the new user or login.
- to add a new book.
- to list all the books added by the current logged-in user.
- to get a single book by it's **id**.
- to update a book. and
- to delete a book.
# Linting and Formatting commands
poetry run ruff check .
poetry run ruff check --fix .
poetry run ruff format .
poetry run pylint $(git ls-files '*.py')