README.md

Library API

Manage library members and borrowing of books by the members.

· Report Bug · Request Feature

Table of Contents

1. • Features
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. License
4. Acknowledgments

Features

• Register/Login
• Act based on user role
• List and filter books and users
• CRUD operations for books
• Admin CRUD operations for users
• Borrow books
• Return books
• Rate books
• Filter book by their genre type
• Middlewares for user and admin authentication

(back to top)

Built With

• Node.js
• Express.js
• MongoDB
• MongooseORM
• ESLint
• Husky

(back to top)

Getting Started

Prerequisites

• yarn

  npm install --global yarn

Installation

1. Clone the repo

   git clone git@github.com:Peri7at/library-api.git

2. Navigate to the project folder

   cd library-app

3. Install dependencies

   yarn

4. Run the project

   yarn start

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Acknowledgements

• 

• 

• 

(back to top)