Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
zxdhiru authored Oct 19, 2024
1 parent f95d838 commit 6735653
Showing 1 changed file with 88 additions and 0 deletions.
88 changes: 88 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
# Library Management System API

This project is a Library Management System API built using Node.js and Express.js. The API manages books, authors, students, and transactions (issuing and returning books).

## Table of Contents
- [Getting Started](#getting-started)
- [API Routes](#api-routes)
- [Books API](#1-books-api)
- [Authors API](#2-authors-api)
- [Students API](#3-students-api)
- [Transactions API](#4-transactions-api)
- [Installation](#installation)
- [Technologies Used](#technologies-used)

---

## Getting Started

To get a local copy up and running, follow these simple steps.

### Prerequisites

You need to have Node.js and npm installed on your system. You can download them from [Node.js Official Website](https://nodejs.org).

### Installation

1. Clone the repository:

```bash
git clone https://github.com/your-username/library-management-system.git


2. Navigate to the project directory:

cd library-management-system


3. Install dependencies:

npm install


4. Start the server:

npm start

The server will be running at http://localhost:3000.




---

API Routes

1. Books API

Base Route: /api/v1/books


2. Authors API

Base Route: /api/v1/authors


3. Students API

Base Route: /api/v1/students


4. Transactions API

Base Route: /api/v1/transactions



---

Technologies Used

Node.js: JavaScript runtime built on Chrome's V8 JavaScript engine.
Express.js: Fast, unopinionated, minimalist web framework for Node.js.
MongoDB: NoSQL database used to store book, author, student, and transaction data.
Mongoose: ODM (Object Data Modeling) library for MongoDB and Node.js.

0 comments on commit 6735653

Please sign in to comment.