Pizza Shopping API

Bem-vindo à API do Pizza Shopping! Esta API é o backend para o aplicativo Pizza Shopping, fornecendo uma interface RESTful para gerenciar pizzas, promoções, usuários e muito mais.

Tabela de Conteúdos

Features
Tecnologias Utilizadas
API Endpoints
Como Usar
Contribuindo
Licença

🚀 Features

Gerenciamento de Usuários: Crie, leia, atualize e exclua usuários.
Autenticação: Sistema de autenticação seguro baseado em JSON Web Tokens (JWT).
Gerenciamento de Pizzas: API completa para gerenciar o cardápio de pizzas.
Promoções Diárias: Crie e gerencie promoções para cada dia da semana.
Cupons de Desconto: Sistema de cupons para oferecer descontos aos clientes.
Banners e Posteres: Gerencie o conteúdo visual do aplicativo.
Horário de Funcionamento: Defina o horário de funcionamento da loja.
Rastreamento de QR Code: Rastreie o uso de QR codes para campanhas de marketing.
Gerenciamento de Revendedores: Gerencie informações sobre os revendedores parceiros.

🛠️ Tecnologias Utilizadas

Backend: Node.js, Express, TypeScript
Banco de Dados: PostgreSQL
ORM: Prisma
Autenticação: JSON Web Token (JWT)
Validação: Joi
Linting: ESLint
Containerização: Docker

📖 API Endpoints

A seguir estão os endpoints disponíveis na API:

Rota	Descrição	Métodos Suportados
`/v1/login`	Autenticação de usuários.	`POST`
`/v1/user`	Gerenciamento de usuários.	`GET`, `POST`, `PUT`, `DELETE`
`/v1/coupon`	Gerenciamento de cupons de desconto.	`GET`, `POST`, `PUT`, `DELETE`
`/v1/banner`	Gerenciamento de banners.	`GET`, `POST`, `PUT`, `DELETE`
`/v1/business-hours`	Gerenciamento do horário de funcionamento.	`GET`, `POST`, `PUT`, `DELETE`
`/v1/action-poster`	Gerenciamento de posteres de ação.	`GET`, `POST`, `PUT`, `DELETE`
`/v1/pizza`	Gerenciamento de pizzas.	`GET`, `POST`, `PUT`, `DELETE`
`/v1/daily-promotion`	Gerenciamento de promoções diárias.	`GET`, `POST`, `PUT`, `DELETE`
`/v1/qr-track`	Rastreamento de visitas por QR code.	`POST`
`/v1/resellers`	Gerenciamento de revendedores.	`GET`, `POST`, `PUT`, `DELETE`

Posso adicionar mais detalhes sobre cada endpoint, incluindo exemplos de request e response, se você desejar.

💻 Como Usar

Pré-requisitos

Node.js (versão 20 ou superior)
Docker

Instalação

Clone este repositório:

git clone git@github.com:felipe-seabra/api.pizzashopping.com.br.git
cd api.pizzashopping.com.br

Instale as dependências:
```
npm install
```
Crie um arquivo .env a partir do .env.example e preencha as variáveis de ambiente.
Inicie o banco de dados com Docker:
```
docker-compose up -d
```
Rode as migrações do Prisma:
```
npx prisma migrate dev
```
Inicie o servidor de desenvolvimento:
```
npm run dev
```
A API estará disponível em http://localhost:3001/v1.

🤝 Contribuindo

Contribuições são bem-vindas! Para contribuir com este projeto, siga estas etapas:

Faça um fork deste repositório.
Crie uma nova branch com suas alterações: git checkout -b minha-feature
Faça commit de suas alterações: git commit -m 'Adicionar nova feature'
Faça push para a branch: git push origin minha-feature
Envie um pull request.

📄 Licença

Este projeto está licenciado sob a Licença MIT.