https://github.com/mazensayed91/library-management-system
https://github.com/mazensayed91/library-management-system
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/mazensayed91/library-management-system
- Owner: Mazensayed91
- Created: 2023-09-28T08:27:25.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-09-30T15:33:13.000Z (almost 3 years ago)
- Last Synced: 2025-02-09T19:43:13.056Z (over 1 year ago)
- Language: JavaScript
- Size: 169 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Library Management System
## Technology Stack
- Node.js
- Express.js
- Sequelize (ORM for interacting with the database)
- SQLite (Database)
- JSON Web Tokens (JWT) for authentication
- Rate limiting for API endpoints
- Jest for unit testing
## Prerequisites
- Node.js and npm (Node Package Manager) installed on your system.
- A code editor (e.g., Visual Studio Code).
- Postman or a similar tool for API testing.
## Getting Started
1. **Clone the repository:**
```bash
https://github.com/Mazensayed91/Library-Management-System.git
2. **Navigate to the project directory:**
```bash
cd Library-Management-System
3. **Install dependencies:**
```bash
npm install
4. **Start the server:**
```bash
npm start
The server should now be running on http://localhost:3000.
## API Reference
### Base URL
- Base URL: `http://localhost:3000/api`
### Error Handling
- The API follows standard HTTP status codes for error handling.
- In case of an error, you will receive a JSON response with an error message.
### Endpoints
#### Books
### GET /books
**Description:** Retrieve a list of all books.
**Input:**
**Query Parameters:**
- page (optional): Page number for pagination (default: 1).
- limit (optional): Number of records per page (default: 10).
**Output:**
```json
{
"success": true,
"data": [
{
"id": 1,
"title": "Mazen's Book 2",
"author": "Mazon",
"isbn": "444-233242",
"quantity": 10,
"shelfLocation": "A1",
"createdAt": "2023-09-29T11:59:25.172Z",
"updatedAt": "2023-09-29T11:59:25.172Z"
},
{
"id": 2,
"title": "Mazen's Book 2",
"author": "Mazon",
"isbn": "444-233242",
"quantity": 10,
"shelfLocation": "A1",
"createdAt": "2023-09-29T11:59:25.462Z",
"updatedAt": "2023-09-29T11:59:25.462Z"
},
{
"id": 3,
"title": "Mazen's Book 2",
"author": "Mazon",
"isbn": "444-233242",
"quantity": 10,
"shelfLocation": "A1",
"createdAt": "2023-09-29T12:15:22.786Z",
"updatedAt": "2023-09-29T12:15:22.786Z"
}
],
"pagination": {
"totalRecords": 3,
"currentPage": 1,
"perPage": 3
}
}
```
### GET /books/:id
**Description:** Retrieve information about a specific book.
**Input:** Book ID (e.g., /books/1)
**Output:**
```json
{
"id": 1,
"title": "Mazen's Book 2",
"author": "Mazon",
"isbn": "444-233242",
"quantity": 10,
"shelfLocation": "A1",
"createdAt": "2023-09-28T15:52:25.336Z",
"updatedAt": "2023-09-28T15:52:25.336Z"
}
```
### POST /books
**Description:** Create a new book.
**Input:**
```json
{
"title": "Mazen's Book 2",
"author": "Mazon",
"isbn": "444-233242",
"quantity": 10,
"shelfLocation": "A1"
}
```
#### PUT /books/:id
**Description:** Update information for a specific book.
**Input:**
```json
{
"title": "Updated Book Title",
"quantity": 5
}
```
#### DELETE /books/:id
**Description:** Delete a specific book.
**Input:** Book ID (e.g., /books/3)
#### Borrowers
- **GET /borrowers**: Retrieve a list of all borrowers.
**Input:**
**Query Parameters:**
- page (optional): Page number for pagination (default: 1).
- limit (optional): Number of records per page (default: 10).
**Output:**
```json
{
"success": true,
"data": [
{
"id": 1,
"name": "Mazen Sayed 2",
"email": "mazensayed@example.com",
"registeredDate": "2023-09-28T00:00:00.000Z",
"createdAt": "2023-09-29T11:59:41.480Z",
"updatedAt": "2023-09-29T11:59:41.480Z"
},
{
"id": 2,
"name": "Mazen Sayed 2",
"email": "mazensay3ed@example.com",
"registeredDate": "2023-09-28T00:00:00.000Z",
"createdAt": "2023-09-29T11:59:58.399Z",
"updatedAt": "2023-09-29T11:59:58.399Z"
},
{
"id": 3,
"name": "Mazen Sayed 2",
"email": "mazensay3hd@example.com",
"registeredDate": "2023-09-28T00:00:00.000Z",
"createdAt": "2023-09-29T12:22:50.173Z",
"updatedAt": "2023-09-29T12:22:50.173Z"
}
],
"pagination": {
"totalRecords": 3,
"currentPage": 1,
"perPage": 3
}
}
```
- **GET /borrowers/:id**: Retrieve information about a specific borrower.
- **POST /borrowers**: Create a new borrower.
**Input**
```json
{
"name": "Mazen Sayed 2",
"email": "mazensayed@example.com",
"registeredDate": "2023-09-28"
}
```
**Output**
```json
{
"id": 3,
"name": "Mazen Sayed 2",
"email": "mazensay3hd@example.com",
"registeredDate": "2023-09-28T00:00:00.000Z",
"updatedAt": "2023-09-29T12:22:50.173Z",
"createdAt": "2023-09-29T12:22:50.173Z"
}
```
#### DELETE /borrowers/:id: Delete a specific borrower.
**Input:** Borrower ID (e.g., /borrowers/1)
#### PUT /borrowers/:id: Update information for a specific borrower.
#### Checkout
- **GET /checkout/overdue-books**: Retrieve a list of overdue books.
**Output**
``` json
[
{
"id": 2,
"bookId": 1,
"borrowerId": 2,
"checkoutDate": "2023-09-29T12:07:32.963Z",
"dueDate": "2023-09-29T12:07:32.963Z",
"returned": false,
"createdAt": "2023-09-29T12:07:32.966Z",
"updatedAt": "2023-09-29T12:07:32.966Z",
"Book": {
"id": 1,
"title": "Mazen's Book 2",
"author": "Mazon",
"isbn": "444-233242",
"quantity": 10,
"shelfLocation": "A1",
"createdAt": "2023-09-28T15:52:25.336Z",
"updatedAt": "2023-09-28T15:52:25.336Z"
}
}
]
- **POST /checkout**: Create a new checkout record.
**Input**
```json
{
"bookId": 1,
"borrowerId": 2
}
```
**Output**
```json
{
"message": "Book checked out successfully"
}
```
#### Reports
- **GET /report/generate-periodic-borrowing-report**: Generate a CSV report for the borrowing process in a specific period.
- **GET /report/generate-overdue-borrows-csv-report**: Generate a CSV report for overdue borrows.
- **GET /report/generate-last-month-borrowing-csv-report**: Generate a CSV report for borrowing processes in the last month.
### Database Schema
- The application uses an SQLite database with the following schema assuming user in a seprate diagram:
- **Books**: Contains information about books.
- **Borrowers**: Contains information about borrowers.
- **Checkout**: Contains records of book checkouts.
- **User**: Contains the user's data used for auth.
### Application Unit Testing
| UnitTest | Description | Expected Return |
| ------------------------------------------| -------------------------------------------------|-----------------------------------|
|book.test.js | Create Book | 201 |
|book.test.js | Create Book without title | SequelizeValidationError |
- Unit tests for the application can be run using the following command:
```bash
npm test