https://github.com/nkosi-tauro/product-api

A Simple CRUD API built with NestJS
https://github.com/nkosi-tauro/product-api

mongodb mongoose nestjs typescript

Last synced: 6 days ago
JSON representation

A Simple CRUD API built with NestJS

• Host: GitHub
• URL: https://github.com/nkosi-tauro/product-api
• Owner: nkosi-tauro
• License: mit
• Created: 2021-05-05T11:25:43.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2021-05-10T11:41:24.000Z (over 3 years ago)
• Last Synced: 2024-11-25T17:25:23.245Z (2 months ago)
• Topics: mongodb, mongoose, nestjs, typescript
• Language: TypeScript
• Homepage:
• Size: 115 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        

Product Api




  

  

  

  

  

  

  






## :dart: About ##

A Simple CRUD API built with NestJS

## :sparkles: Features ##

:heavy_check_mark: User can GET/POST/PATCH/DELETE Products

## :rocket: Technologies ##

The following tools were used in this project:

- [Nest.js](https://nestjs.com/)

- [Node.js](https://nodejs.org/en/)

- [MongoDB](https://cloud.mongodb.com/)

## :white_check_mark: Requirements ##

Before starting :checkered_flag:, you need to have [Git](https://git-scm.com) and [Node](https://nodejs.org/en/) installed.

## :checkered_flag: Starting ##

```bash

# Clone this project

$ git clone https://github.com/nkosi-tauro/product-api

# Access

$ cd product-api

#MongoDB

$ update connection string to your DB

# Install dependencies

$ npm install

# Run the project

$ npm start

# The server will initialize in the 

```

## :checkered_flag: Usage ##

**Using Postman** or a service of your choice

```bash

# POST new Product

$ http://localhost:3000/products

-> Body -> JSON

{

    "title": "New Title",

    "description": "New Description",

    "price": 13000

}

# GET All Products

$ http://localhost:3000/products

# GET Single Product

http://localhost:3000/products/:id

# PATCH  Product

$ http://localhost:3000/products/:id

-> Body -> JSON

{

    "title": "New Udpated Title",

    "description": "New Udpated  Description",

    "price": 13000

}

# Delete Single Product

http://localhost:3000/products/:id

```

## :memo: License ##

This project is under license from MIT. For more details, see the [LICENSE](LICENSE.md) file.

Made with :heart: by Nkosilathi Tauro

 

Back to top