mailsg / crudlib

A backend service to perform CRUD operations.

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Setup
  • Install
  • Usage
• 👥 Author
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

Bookstore API

Bookstore API is a backend service used to perform CRUD operation with books. It is built with NodeJS and uses MongoDB as the database.

🛠 Built With

Tech Stack

Server

• NodeJS

Database

• MongoDB

Key Features

• API Endpoints to perform CRUD operations
• Database deployment on Mongo Atlas

(back to top)

💻 Getting Started

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

Prerequisites

Setup

Clone this repository to your desired folder:

  git clone https://github.com/mailsg/crudlib.git
  cd crudlib  

Install

Install this project by executing the following commands. Since its an Open API, there is no need to set up any API keys:

  cd crudlib

  npm install

  touch .env
    `Add the following lines to the .env file`
      MONGODB_URI=`Your MongoDB-Atlas URI (mongodb+srv)`
      DATABASE_NAME=`Your MongoDB Database Name`
      COLLECTION_NAME=`Your MongoDB Collection Name`

  - Please note that the above 3 variables are mandatory for the project to run.

  - I have used Database Name as `library` and Collection Name as `books` for this project. You can use any name of your choice or use the same as mine.
  
  - The database and collection has to be created manually in MongoDB Atlas.

Usage

To run the project, execute the following command:

  npm start

Below are the Endpoints to perform CRUD operations:

• GET http://localhost:3000/api/books - Get all books
• GET http://localhost:3000/api/books/:id - Get a book by id
• POST http://localhost:3000/api/books - Create a new book
  • Request Body

    {
      "title": "Book Title",
      "author": "Book Author",
      "summary": "Book Summary"
    }

• PUT http://localhost:3000/api/books/:id - Update a book by id
  • Request Body (Any or all of the following)

    {
      "title": "Book Title", 
      "author": "Book Author",
      "summary": "Book Summary"
    }

• DELETE http://localhost:3000/api/books/:id - Delete a book by id

👤 Sandeep Ghosh

• GitHub: @mailsg
• LinkedIn: LinkedIn

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project consider leaving a star to the repository.

(back to top)

🙏 Acknowledgments

Thank you for giving me the opportunity to showcase my skills.

(back to top)

📝 License

This project is MIT licensed.

(back to top)