Tecnologias   |    Projeto   |    Instalação   |    Iniciar projeto   |    Estrura do banco de dados   |    Coverage   |   

🚀 Tecnologias

Este projeto foi desenvolvido com as seguintes tecnologias:

• Node
• Express
• Typescript
• Prisma
• Jest
• Amazon s3
• PostgreSQL

💻 Projeto

Los Hermanos dashboard é uma API desenvolvida para um projeto de gerenciamento da pizzaria Los Hermanos, a aplicação tem como objetivo controlar as vendas do estabelecimento e gerar gráficos de desempenho para que os proprietários possam analisar seu negócio e identificar pontos com capacidade de melhora. O sistema atualmente conta com as seguintes funcionalidades:

• Cadastro de conta
• Cadastro de múltiplos usuários para mesma conta
• Autenticação de usuário
• Gerenciamento de produtos (Criação, Edição, Atualização e Deleção)
• Gerenciamento de clientes (Criação, Edição, Atualização e Deleção)
• Gerenciamento de vendas (Criação, Edição, Atualização e Deleção)
• Levantamento de total diário arrecadado
• Levantamento de total arrecadado no mês
• Levantamento de total de pedidos no mês
• Balanço mensal, com criação de histórico anual
• Rankeamento de produtos mais vendidos

👷 Instalação

Você precisa instalar Node.js e Yarn primeiro, então, clone o repositório utilizando o seguinte comando:

git clone https://github.com/hitaloalvess/loshermanos-dashboard-server.git

Instalando dependências

yarn install

# or

npm install

Após a instalação, crie suas variáveis de ambiente para usar neste projeto (com base no exemplo de .env.example):

cp .env.example .env

Configurar um banco de dados

O banco de dados PostgreSQL está sendo usado neste projeto. Se você tiver o Docker instalado em sua máquina, preencha os valores de ambiente relacionados às configurações do banco de dados e execute os seguintes comandos para criar um container PostgreSQL:

docker-compose up -d

🏃 Iniciar projeto

Após realizar todos os procedimentos da seção de instalação, basta iniciar a API utilizando o seguinte comando:

yarn dev

Na sequência basta acessar http://localhost:3333/ para utilizar as rotas disponibilizadas pela API.

Estrutura do banco de dados

Diagrama de classes

Coverage

📝 License

Este projeto está sob a licença do MIT. Veja o LICENSE para maiores informações.

---

Made with ♥ by Hitalo 🚀