https://github.com/vaibhav-rm/library-management-system
https://github.com/vaibhav-rm/library-management-system
hacktober hacktoberfest hacktoberfest-accepted hacktoberfest2023 hacktoberfest2024
Last synced: 9 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/vaibhav-rm/library-management-system
- Owner: vaibhav-rm
- Created: 2024-08-20T14:28:38.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-18T18:01:27.000Z (over 1 year ago)
- Last Synced: 2025-05-27T04:16:11.824Z (about 1 year ago)
- Topics: hacktober, hacktoberfest, hacktoberfest-accepted, hacktoberfest2023, hacktoberfest2024
- Language: JavaScript
- Homepage:
- Size: 1.09 MB
- Stars: 5
- Watchers: 1
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Library Management System
## Project Overview
This project is a Library Management System built using React for the frontend and Node.js for the backend. It allows users to manage books, users, and lending processes efficiently.
## Tech Stack
- **Frontend:** React, Vite, TailWindCss
- **Backend:** Node.js, Express
- **Database:** MongoDB
## Getting Started
### Prerequisites
- Node.js installed on your machine
- npm (Node Package Manager) should be included with Node.js
### Installation
1. Clone the repository:
```bash
git clone https://github.com/vaibhav-rm/Library-management-system.git
cd Library-management-system
```
2. Install dependencies for the frontend:
```bash
npm install
```
3. Install dependencies for the backend:
```bash
cd backend
npm install
```
### Running the Application
#### Frontend
To run the frontend, use the following command (by default runs at `http://localhost:8000`):
```bash
npm run dev
```
This will start the Vite development server, and you can access the application at `http://localhost:5173`.
#### Backend
To run the backend, first, navigate to the backend directory:
```bash
cd backend
```
Then, run the following command:
```bash
npm run dev
```
This will start the Node.js server, and you can access the API endpoints as specified in the backend code.
## Features
- User authentication (login/register)
- Book management (add, remove, update, view)
- User management (add, remove, update, view)
- Lending management (track borrowed books, due dates, etc.)
## Contributing
If you want to contribute to this project, feel free to fork the repository and submit a pull request.
## License
This project is licensed under the MIT License. See the LICENSE file for more details.
## Screenshots
### Admin Login
### Student Login
## API Reference
#### Api url
```http
http://localhost:8000/api/v1/{ENDPOINT}
```
| Parameter | Type | Description |
| :-------- | :------- | :------------------------- |
| `ENDPOINT` | `string` | **Required**. which resoruce you want to use |
## For more information visit Project Documentation
- [LMS Documentation]()
- [Api Documentation]()
## Acknowledgements
- [React](https://reactjs.org/)
- [Node.js](https://nodejs.org/)
- [MongoDB](https://www.mongodb.com/)