Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kenmarcos/customers-cvlb_api

expressjs nodejs postgresql supabase typeorm typescript yup

Last synced: about 1 month ago
JSON representation

Host: GitHub
URL: https://github.com/kenmarcos/customers-cvlb_api
Owner: kenmarcos
Created: 2023-11-16T18:47:55.000Z (about 1 year ago)
Default Branch: main
Last Pushed: 2024-03-01T17:25:25.000Z (10 months ago)
Last Synced: 2024-04-24T09:14:08.795Z (8 months ago)
Topics: expressjs, nodejs, postgresql, supabase, typeorm, typescript, yup
Language: TypeScript
Homepage:
Size: 69.3 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        


    

       Grupo CVLB - API de Clientes

    

    

        Sobre o Projeto •

        Endpoints •

        Utilização •

        Tecnologias •

        Autor

    



## 🖥️ Sobre o Projeto

> Projeto desenvolvido como etapa do processo seletivo do Grupo CVLB.

Esse projeto consiste em uma aplicação back-end de um sistema de gerenciamento de clientes de uma loja fictícia.

Esse serviço possui uma API REST integrada a um banco de dados PostegreSQL.

A aplicação completa (Back-end e Front-end) pode ser vizualizada **[aqui](https://cvlb-clientes.vercel.app)**.

Algumas funcionalidades dessa aplicação são:

- [x] Cadastrar e gerenciar clientes

- [x] Ativar participação de cliente em Clube de Vantagens

- [x] Listar todos os clientes

- [x] Retornar os detalhes de um cliente específico

- [x] Atualizar os dados pessoais de um cliente

- [x] Remover um cliente

- [x] Cadastrar endereço vinculado a um cliente

- [x] Remover um endereço

## 💡 Endpoints

| Método | Endpoint                 | Responsabilidade                        | Regras de Negócio |

| ------ | ------------------------ | --------------------------------------- | ----------------- |

| GET    | /customers               | Lista todos os clientes                 |                   |

| GET    | /customers/\ | Retorna um determinado cliente pelo id  |                   |

| POST   | /customers               | Cria um cliente                         |                   |

| PATCH  | /customers/\ | Atualiza informações do cliente         |                   |

| DELETE | /customers/\ | Remove um cliente do sistema            |                   |

| POST   | /address/                | Cria um endereço vinculado a um cliente |                   |

| DELETE | /address/\    | Remove um endereço                      |                   |

## 🚀 Utilização

> Para utilizar a aplicação, é necessário o uso de uma API Client, como [Postman](https://www.postman.com/) ou [Insomnia](https://insomnia.rest/download).

Faça as requisições na aplicação utilizando uma API Client.

url da api: https://customers-cvlb-api.onrender.com

## 🛠️ Tecnologias

Para o desenvolvimento desse projeto, as seguintes ferramentas foram utilizadas:

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

- **[Express.js](https://expressjs.com/)**

- **[TypeScript](https://www.typescriptlang.org/)**

- **[TypeORM](https://typeorm.io/)**

- **[Yup](https://www.npmjs.com/package/yup)**

## 👨‍💻 Autor



Marcos Kenji Kuribayashi

[![Linkedin Badge](https://img.shields.io/badge/-LinkedIn-blue?style=flat&logo=Linkedin&logoColor=white)](https://www.linkedin.com/in/marcos-kuribayashi/) [![Gmail Badge](https://img.shields.io/badge/[email protected]?style=flat&logo=Gmail&logoColor=white)](mailto:[email protected])

---

Desenvolvido por Marcos Kenji Kuribayashi 😉