https://github.com/samuel-ricardo/product-manager_api
NestJS API to manage products
https://github.com/samuel-ricardo/product-manager_api
Last synced: 3 months ago
JSON representation
NestJS API to manage products
- Host: GitHub
- URL: https://github.com/samuel-ricardo/product-manager_api
- Owner: Samuel-Ricardo
- License: mit
- Created: 2023-07-08T19:25:30.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-07-09T03:12:56.000Z (almost 2 years ago)
- Last Synced: 2025-01-14T12:43:49.412Z (5 months ago)
- Language: TypeScript
- Size: 113 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Product Manager
🚀 🟥 Discovery 🟥 🚀
Application developed with the purpose of studying the NestJS Ecosystem
#
|
Overview |
Technologies |
Project |
Routes |
Run |
Author |
#
| :artificial_satellite: About:
This API is a tradicional CRUD that make the essentials operations like Create, Update and Delete Products that have relation with Category in MySQL database integrates using Prisma, all that using middlewares, Clean Architeture, Data Validations and more.
:building_construction: | Technologies and Concepts Studied:
> 
- NestJS
- Prisma
- MySQL
- Typescript
- JS
- Test
- Jest
- Docker
- eslint
- prettier
- husky
- class-validator
- class-tranformer
- lint-sataged
> Among Others...
#
💻 | Application:
> API Example:
```bash
$ product_manager > api.http
### Category ###
###
GET http://localhost:3000/category
###
GET http://localhost:3000/category/1
###
POST http://localhost:3000/category
Content-Type: application/json
{
"name": "Category 1i2"
}
###
PATCH http://localhost:3000/category/1
Content-Type: application/json
{
"name": "Category 1 Updated"
}
###
DELETE http://localhost:3000/category/1
###
### Products ###
###
GET http://localhost:3000/products
###
GET http://localhost:3000/products/1
###
POST http://localhost:3000/products
Content-Type: application/json
{
"name" : "Product 1",
"price" : 100,
"categoryId": 1
}
###
PATCH http://localhost:3000/products/1
Content-Type: application/json
{
"name" : "Product 1 Updated",
"price" : 50
}
###
DELETE http://localhost:3000/products/1
###
```
#
👨💻 | How to use
### Open your Git Terminal and clone this repository
```git
$ git clone "[email protected]:Samuel-Ricardo/product-manager_API.git"
```
### Make Pull
```git
$ git pull "[email protected]:Samuel-Ricardo/product-manager_API.git"
```
This application use `Docker` so you dont need to install and cofigurate anything other than docker on your machine.
> 
Navigate to project folder ` $ cd ./product_manager/ ` and run it using ` docker-compose `
```bash
# After setup docker environment just run this commmand on root project folder:
$ docker-compose up --build # For First Time run this command
$ docker-compose up # to run project
```
```bash
#Apps Running on:
$ API: http://localhost:3000
$ MySQL: http://localhost:3306
See more: ./product_manager/docker-compose.yaml
```
#
#
:octocat: | Author:
