Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/enginkaratas/library-management
A library managing application with member, and borrowing management
https://github.com/enginkaratas/library-management
Last synced: 5 days ago
JSON representation
A library managing application with member, and borrowing management
- Host: GitHub
- URL: https://github.com/enginkaratas/library-management
- Owner: EnginKARATAS
- License: mit
- Created: 2024-12-02T21:35:06.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2024-12-03T11:18:12.000Z (about 1 month ago)
- Last Synced: 2024-12-03T12:24:18.955Z (about 1 month ago)
- Language: TypeScript
- Homepage:
- Size: 41 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Rainbow Library - Book Management System
A cute and modern library management system built with React, TypeScript, Express, and TypeORM.
go to api design [page](https://miro.com/welcomeonboard/NjFraUc4UXY0V2lDd252Z0FjU2FCNzQzOSsySjd6RnR0eVV6bUY2dGNzT0xGb3R4VXZQaXAwSEp5RW9wR3V3OUJ1SFJ2aUxzTFN0R0RjUFg5SFBaV1FVcDNFaUg5SnFXY0RyRm0wOE9IMWR6dHFoWjRzb3d5MkN3TjZIV1ZybWMhZQ==?share_link_id=646538550223)
## Features
- Book management (borrowing, returning, rating)
- User management
- Book rating system
- Modern and cute UI design
- Responsive
-
- Error handling wiht popup and snackbars
## Prerequisites
- Postgres 17 or higher
- Node.js (v14 or higher)
- npm or yarn
- MySQL/PostgreSQL database
## Tech Stack
### Frontend
- React
- TypeScript
- Material-UI
- Toolpad UI
- Redux Toolkit
- SCSS
- Vite
### Backend
- Express.js
- TypeORM
- TypeScript
## Installation
1. Clone the repository:
```bash
git clone https://github.com/yourusername/library-management.git
cd library-management
```
2. Install dependencies for both frontend and backend:
```bash
# Install backend
npm install
# Install frontend
cd library-frontend
npm install
```
3. Configure your database:
- Create a new database
`db here`
- create a .env file at root(by default, you dont have to change those info.)
```json
DB_HOST=localhost
DB_PORT=5432
DB_USERNAME=postgres
DB_PASSWORD=123
DB_NAME=library_db
```
## Running the Application
# Choose One:
### Auto Database Creation
* After installing all dependencies at the root of the app (using `npm i`), create a postgres db named `library_db` in the PostgreSQL pgAdmin4 application.
* Then, run `npm start` at the root of the application.
### Manual Database Creation
* Download the `library_db_backup.sql` file in the root of the directory.
* In the PostgreSQL pgAdmin4 application, create a database named `library_db`.
* Remove the `library_db>Schemas>public` schema.
* Right-click on the `library_db` database and select "Restore".
* Choose the `library_db_backup.sql` file and click "Restore".
* Start the backend server:
# After Db Setup:
```bash
# From the root directory
npm run start
```
2. Start the frontend development server:
```bash
# From the library-frontend directory
npm run dev
```
The application will be available at:
- Frontend: http://localhost:5173
- Backend API: http://localhost:3000
## API Endpoints
**Library DB API Design**
**GET API Endpoints**
* **Get Users (/users)**
* **Get User (/users)**
* **Get User with Borrow History (/users/:id)**table. If `lendStatus` equals 2, selects all records with a score.
* **Get Books (/books)**
* **Get Book (/books/:id)**
**POST API Endpoints**
* **Borrow Book (/users/:id/borrow/:id)**
* **Return Book (/users/:id/return/:id)**point for the removed user, and updates the original table userScore. Inserts into the Lend table with `lendStatus` set to 1.
**API Response Codes**
* All successful GET API requests will return a 200 OK status code.
* All successful POST API requests will return a 204 OK status code.