Git Product home page Git Product logo

brew-app's Introduction

Nest Logo

A progressive Node.js framework for building efficient and scalable server-side applications.

NPM Version Package License NPM Downloads CircleCI Coverage Discord Backers on Open Collective Sponsors on Open Collective Support us

Description

Brew App provides a bunch of API's for book management. Project is live at -

https://blushing-tick-bracelet.cyclic.app/
Book Schema - 
{
 _id: Mongoose Object Id,
 title: string,
 author: string,
 summary: string
 }

1. POST API

This API will post new book to the db

endpoint - {{baseUrl}}/book
request body example - 
{
    "title": "Train to Busan",
    "author": "Mary Jane",
    "summary": "horror book"
}

Please Note unique ID is auto-generated by MongoDB, we don't provide it explicitly in the request body.

2. GET ALL Books API

This API will retrieve all the books in the database

endpoint - {{baseUrl}}/book
request body example - NA

3. GET Book by ID API

This API will retrieve the book with the given id in the database

endpoint - {{baseUrl}}/book/{id}
request body example - NA

4. Patch Book by ID API

This API will update the book with the given ID in the database

endpoint - {{baseUrl}}/book/{id}
request body example - 
{
    "title": "Train to Busan",
    "author": "Mary Jane",
    "summary": "horror book"
}

5. DELETE Book by ID API

This API will delete the book with the given ID from the database

endpoint - {{baseUrl}}/book/{id}
request body example - NA

Installation

Clone the repository in your local machine.
run npm install
You will need to provide MONGODB_URI in env.development file to connect with MongoDB instance.
Please ping me for same.

Running the app

npm run start

brew-app's People

Contributors

himanshuhx avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.