https://github.com/jibbs1703/libooktrac
LiBookTrac is a modern and efficient library management system designed to streamline the management and tracking of library resources. This project leverages the python frameworks Pydantic and FastAPI, to provide a robust and high-performance solution for library administrators and users.
https://github.com/jibbs1703/libooktrac
books data-modeling database-management fastapi library-management-system mongodb pydantic
Last synced: about 2 months ago
JSON representation
LiBookTrac is a modern and efficient library management system designed to streamline the management and tracking of library resources. This project leverages the python frameworks Pydantic and FastAPI, to provide a robust and high-performance solution for library administrators and users.
- Host: GitHub
- URL: https://github.com/jibbs1703/libooktrac
- Owner: jibbs1703
- License: mit
- Created: 2025-01-19T17:05:48.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-02T13:57:33.000Z (over 1 year ago)
- Last Synced: 2025-03-02T14:32:19.501Z (over 1 year ago)
- Topics: books, data-modeling, database-management, fastapi, library-management-system, mongodb, pydantic
- Homepage:
- Size: 9.77 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# LiBookTrac: A Library Management System
[](https://pydantic.dev)
## Overview
LiBookTrac is an efficient library management system developed to streamline the management and tracking of
library resources. Leveraging the capabilities of **Pydantic** and **FastAPI**, this project offers a robust
and high-performance solution for both library administrators and users.
## Features
- **User Management:** Add, update, and manage library users effortlessly.
- **Book Management:** Comprehensive features for adding, updating, and removing books from the collection.
- **Loan Management:** Efficiently track and manage book borrowings and returns.
- **Search Functionality:** Powerful search capabilities to quickly locate books and users.
- **API Documentation:** Automatically generated and interactive API documentation using FastAPI.
## Technologies Used
- **FastAPI:** A modern web framework for building APIs with Python based on standard Python type hints.
- **Pydantic:** Data validation and settings management using Python type annotations.
- **PostgreSQL:** A relational database management system for storing library data.
## Getting Started
- **Clone the repository:**
```bash
git clone https://github.com/your-username/LiBookTrac.git
cd LiBookTrac
```
- **Create and Activate Virtual Environment:**
```bash
python -m venv libooktrac
libooktrac\Scripts\activate
```
- **Install Project Requirements:**
```bash
pip install -r requirements.txt
```
- **Run Library Management Application Locally:**
```bash
uvicorn app.main:app --host 127.0.0.1 --port 8008
```
- **Run Library Management Application in Container:**
```bash
docker build -f backend.Dockerfile -t libooktrac:latest .
docker rm -f libooktrac-env || true # Remove existing container if it exists
docker run -it --name libooktrac-env -v .:/workspace -p 8000:8000 libooktrac:latest
docker exec -it libooktrac-env sh
```
- TODO
- use isbn check to input book details (external API exists)