• Descrição • Inicializando • Endpoint • Banco de Dados • Lista de Ideias •

💻 Descrição

Um estudo para o desenvolvimento do backend de e-commerce.

Funcionalidades

• CRUD de usuário e produto;
• Login com autorização e autenticação através de JSON Web Token;
• Carrinhos de compra por usuário;
• Revisão do preço e disponibilidade dos itens ao pagar o carrinho;
• Pagamento por cartão de crédito e PIX respectivamente manejados pelos Gateways de Pagamento Stripe e AbacatePay;
• Processamento da resposta dos pagamentos por PIX através do BullMQ para controlar os itens reservados e o status do carrinho;
• Suporte de testes unitários e integrados utilizando do Node Test Runner;

🚀 Inicializando

Passos para utilizar este projeto:

/ Instalação do projeto / Configuração das variáveis de ambiente / Instalações dos Softwares / Inicialização /

Instalação do projeto

Clone o projeto ou baixe-o;

gh repo clone NicolasChirazawa/e-commerce

Definindo as variáveis de ambientes

Use o arquivo '.env-teste' de referência para criar o seu próprio '.env', e defina as seguintes variáveis de acordo a descrição.

SERVER_PORT = /* Porta do Express */

POSTGRES_HOST =     /* Configuração do host do Postgres */
POSTGRES_PORT =     /* Configuração da porta do Postgres */
POSTGRES_DATABASE = /* Configuração da base de dados do Postgres */
POSTGRES_USER =     /* Configuração do user do Postgres */
POSTGRES_PASSWORD = /* Configuração da senha do Postgres */

REDIS_HOST = /* Configuração do host do Redis */ 
REDIS_PORT = /* Configuração da porta do Redis */

JWT_SECRET = /* Segredo do JWT */

STRIPE_SECRET_KEY =  /* Chave do gateway de pagamento Stripe */
ABACATE_SECRET_KEY = /* Chave do gateway de pagamento Abacate Pay */

Softwares necessários

• Docker (Windows / Linux);
• Postgres;

Recomendação: Um editor de código: Visual Studio Code;

Recomendação: Um Cliente API para manejar requisições, como o: Postman ou o Insomnia;

Inicialização

docker-compose up

📍 Endpoints API

Users

rotas	descrição
POST/register	Registra um usuário.
POST/login	Loga no sistema para gerar um JWT.
GET/users	Apanha informações dos usuários.
GET/users:/user_id	Apanha informação do usuário selecionado.
PUT/users:/user_id	Atualiza todas as informações do usuário selecionado.
DELETE/users:/user_id	Deleta um usuário específico.
PATCH/users:/user_id	Atualiza um ou mais campos de um usuário específico.

Products

rotas	descrição
POST/products	Registra um produto.
GET/products	Apanha informações dos produtos.
GET/products:/product_id	Apanha informação do produto selecionado.
PUT/products:/product_id	Atualiza todas as informações do produto selecionado.
DELETE/products:/product_id	Deleta um produto específico.
PATCH/products:/product_id	Atualiza um ou mais campos de um produto específico.

Shopping_Products

rotas	descrição
GET/shoppingCart	Apanha os itens de todos os carrinhos de compra.
GET/shoppingCart/:cart_id	Apanha os itens de um carrinho de compra específico
POST/currentCart/:product_id	Acrescenta um item no carrinho de compras atual.
GET/currentCart	Apanha informações do carrinho de compra atual do usuário.
DELETE/currentCart/:product_id	Deleta um produto do carrinho de compras atual do usuário.
PATCH/currentCart/:product_id	Atualiza um atributo específico do carrinho de compras atual do usuário.
POST/updatePrice	Atualiza o preço dos itens do carrinho de compra atual do usuário.
POST/verifyStorage	Verifica os itens do carrinho de compra atual.

Products

rotas	descrição
POST/payment	Gera o código PIX para pagamento de um carrinho de compra.

🧱 Banco de dados

📋 Lista de Tarefas

• Estruturação do banco de dados;
• CRUD usuários;
• Login de usuários com bcrypt e JWT;
• CRUD de produtos;
• Carrinho de compras por usuário;
• Testes unitários;
• Testes integrados;
• Verificação de produtos no estoque ao pagar;
• Verificação da precificação dos produtos no carrinho de compras;
• Implementação do Gateway de pagamento Stripe;
• Implementação do Gateway de pagamento AbacatePay;
• Implementação do BullMQ para o processamento do PIX;
• Criação do Docker;
• Criação do Swagger para documentação da API;