book-api

A simple express project showcasing REST APIs

Table of Contents

• Installation
• Usage
• Features
• Contributing
• License

Installation

1. Clone the repository:

   git clone https://github.com/shashikrs/book-api.git

2. Navigate to the project directory:

   cd book-api

3. Initialize the project:

   npm init -y

4. Install dependencies:

   npm install express mongoose dotenv nodemon

Usage

To start the project, run: (development)

npm run start-dev

To start the project, run: (production)

npm start

Open your browser and go to http://localhost:3000/api/v1.

For swagger docs go to http://localhost:3000/api-docs.

Features

• Basic routes
• Middleware
• Error Handling
• REST API (CRUD)

Contributing

Contributions are welcome! Please open an issue.

License

This project is licensed under the MIT License. See the LICENSE file for details.