Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/albinzayedrawan/lmsproject

This project is a Library Management System (LMS) built with Node.js, Express, MongoDB, and Mongoose. It includes role-based access control (RBAC) to manage different user roles and their permissions.
https://github.com/albinzayedrawan/lmsproject

backend-service expressjs jwt-authentication library-management-system mongodb nodejs

Last synced: 10 days ago
JSON representation

Host: GitHub
URL: https://github.com/albinzayedrawan/lmsproject
Owner: albinzayedrawan
Created: 2024-12-19T19:51:10.000Z (16 days ago)
Default Branch: main
Last Pushed: 2024-12-19T19:52:32.000Z (16 days ago)
Last Synced: 2024-12-19T20:29:52.642Z (16 days ago)
Topics: backend-service, expressjs, jwt-authentication, library-management-system, mongodb, nodejs
Language: JavaScript
Homepage:
Size: 0 Bytes
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# Library Management System (LMS)

## Features

- **Books Management**: Add, update, delete, and query books.
- **Members Management**: Add, update, delete, and query members.
- **Loans Management**: Manage book loans.
- **Users Management**: Add, update, delete, and query users.
- **Role-Based Access Control (RBAC)**: Manage different user roles and their permissions.

## User Roles and Permissions

- **Librarian**:
- Full access to all collections.
- Can add, update, delete, and query all data.
- Manages member registrations and book loans.
- **Assistant**:
- Limited access to `library_books` and `book_loans`.
- Can query all data but only update certain fields (e.g., updating available copies in `library_books`).
- **Member**:
- Read-only access to `library_books`.
- Can add data to `book_reviews`.
- Access to their own data in `library_members` and `book_loans`.

## Getting Started

### Prerequisites

- Node.js
- MongoDB

### Installation

1. Clone the repository:

```bash
git clone https://github.com/albinzayedrawan/lmsproject.git
cd lmsproject
```

2. Install dependencies:

```bash
npm install
```

3. Create a .env file in the root directory and add the following environment variables:

```properties
DB_URI=mongodb+srv://:@/?retryWrites=true&w=majority
JWT_SECRET=your_jwt_secret_key
PORT=3000
```

4. Seed the database with sample data:

```bash
node seed.js
```

### Running the Server

Start the server:

```bash
node server.js
```

The server will run on `http://localhost:3000`.

## API Endpoints

### Authentication

- **Login**: `POST /api/users/login`

### Books

- **Add Book**: `POST /api/books` (Librarian)
- **Get All Books**: `GET /api/books` (Librarian, Assistant, Member)
- **Get Book by ID**: `GET /api/books/:id` (Librarian, Assistant, Member)
- **Update Book**: `PUT /api/books/:id` (Librarian)
- **Delete Book**: `DELETE /api/books/:id` (Librarian)

### Members

- **Add Member**: `POST /api/members` (Librarian)
- **Get All Members**: `GET /api/members` (Librarian, Assistant)
- **Get Member by ID**: `GET /api/members/:id` (Librarian, Assistant)
- **Update Member**: `PUT /api/members/:id` (Librarian)
- **Delete Member**: `DELETE /api/members/:id` (Librarian)

### Loans

- **Add Loan**: `POST /api/loans` (Librarian)
- **Get All Loans**: `GET /api/loans` (Librarian, Assistant)
- **Get Loan by ID**: `GET /api/loans/:id` (Librarian, Assistant)
- **Update Loan**: `PUT /api/loans/:id` (Librarian)
- **Delete Loan**: `DELETE /api/loans/:id` (Librarian)

### Users

- **Add User**: `POST /api/users` (Librarian)
- **Get All Users**: `GET /api/users` (Librarian)

## Testing with Postman

1. **Login to Get the Token**:
- Create a new request in Postman.
- Set the method to POST.
- Set the URL to `{{baseUrl}}/api/users/login`.
- In the Body tab, select `raw` and `JSON` format.
- Add the following JSON:

```json
{
"email": "[email protected]",
"password": "password123"
}
```

- Send the request.
- Copy the token from the response.

2. **Set Up Environment Variable for Token**:
- Go back to the environment settings.
- Paste the copied token value into the `token` variable.
- Save the environment.

3. **Create Requests for CRUD Operations**:
- Use the token in the `Authorization` header for all authenticated requests:
- Key: `Authorization`
- Value: `Bearer {{token}}`