API BACK-END GRSTORES

Descrição curta do projeto: Uma breve descrição sobre o que o projeto faz e o problema que ele resolve.

---

Sumário

• Descrição do Projeto
• Funcionalidades
• Instalação
• Uso
• Licença

---

Descrição do Projeto

Este projeto é um sistema de API DO SISTEMA DA GRSTORE, desenvolvido para UM E_CORMECE. Ele permite que os usuários ACESSE UMA LOJA VIRTUAL. O código foi implementado utilizando NODE.JS, PRISMA, FASTIFY e TYPESCRIPT.

---

Funcionalidades

• Cadastro de Usuários: Permite que os usuários se registrem e façam login na loja virtual.
• Gestão de Produtos: CRUD (Criar, Ler, Atualizar, Deletar) de produtos na loja, com informações como nome, preço, descrição e imagem.
• Gestão de Categorias: Permite organizar os produtos em categorias.
• Carrinho de Compras: Funcionalidade que permite ao usuário adicionar produtos ao carrinho e realizar checkout.
• Gestão de Pedidos: Visualização e gerenciamento de pedidos dos clientes, incluindo status de pagamento e envio.
• Autenticação e Autorização: Sistema de login, registro e controle de acesso para usuários e administradores.
• Integração com Pagamento: Simulação de integração para pagamentos (exemplo: Stripe ou PayPal).
• Busca e Filtros: Permite aos usuários buscar e filtrar produtos por categorias, preço e nome.

---

Instalação

Siga as etapas abaixo para configurar o ambiente e rodar o projeto localmente.

1. Clone o repositório:

   git clone https://github.com/usuario/nome-do-repositorio.git
   cd nome-do-repositorio
   

2. Baixando as dependencias:

   Execute o comando abaixo para instalar todas as dependências necessárias para o projeto:

   npm install

   Gere os arquivos do Prisma (caso esteja usando Prisma para migrações, caso não, remova esta parte):

   npx prisma generate

3. Variáveis de Ambiente (se necessário):

   .ENV DATABASE_URL=mongodb://<usuário>:<senha>@localhost:27017/nome-do-banco
   
   

Uso

npm run dev


Endpoints principais

A seguir estão alguns dos principais endpoints da API:

POST /auth/register: Registro de um novo usuário.
POST /auth/login: Login de um usuário existente.
GET /products: Lista todos os produtos.
GET /products/:id: Recupera os detalhes de um produto específico.
POST /products: Cria um novo produto (requer permissão de administrador).
PUT /products/:id: Atualiza um produto existente.
DELETE /products/:id: Deleta um produto.
POST /cart: Adiciona um produto ao carrinho.
POST /checkout: Realiza o checkout do carrinho e cria um pedido.

Ferramentas de Desenvolvimento
Jest: Para testes unitários e de integração.
Prettier: Para formatação de código.
ESLint: Para linting de código.

Licença

Este projeto está licenciado sob a MIT License.