The Library Management System is a comprehensive solution for managing a library's various operations, built with React, TypeScript, Tailwind, Redux, and Vite.js. It is designed to simplify the process of borrowing, returning, loaning of books, making/canceling reservations, managing books, with RBAC.
- User Interface: Sleek and modern UI built with Tailwind.
- Borrowing and Returning: Easy process for users to borrow and return books.
- Loaning of Books: Simplified loaning mechanism for authorized users.
- Making/Canceling Reservations: Handle reservations for popular books.
- CRUD Books: Complete control over book creation, retrieval, update, and deletion.
- Manage Users and Roles: Robust User Management and Role-Based Access Control.
Below are the instructions to get the project up and running on your local machine.
curl -fsSL https://bun.sh/install | bash
-
Clone the Repository:
git clone https://github.com/ForAeons/lms-frontend-v2.git
-
Navigate to the Project Directory:
cd lms-frontend-v2
-
Install Dependencies:
bun i
-
Start the Development Server:
bun dev
The application should now be running at http://localhost:5173/
.
-
Make a copy of the
.env.example
file and rename it to.env.development
. -
Make necessary changes to the
.env.development
file. -
Install ESLint and Prettier extensions for your code editor.
-
Optional: Install Go if you haven't already. You can download it from here.
-
Optional: Install Captain Githook (for running pre-commit/pre-push hooks):
go install github.com/swellaby/captain-githook@latest captain-githook init
Note: You only need to do this if you are serving the frontend from the Go backend as static files, which is the default behavior.
-
Build the Project:
bun run build
-
Copy the Build Files to the Backend:
cp -r dist/* ../lms-backend/frontend/ # Assuming you are in the lms-frontend-v2 directory and the backend is in the parent directory
-
Commit and Push the Changes in the Backend
This project is licensed under the MIT License - see the LICENSE file for details.