Projeto API - 3º Semestre

🎯 Objetivo

Desenvolver uma solução dinâmica e eficiente para a análise de dados de vendas, utilizando planilhas do Excel como fonte de informação. Nosso objetivo é fornecer uma ferramenta acessível e intuitiva que permita a empresa entender melhor seu desempenho de vendas e tomar decisões estratégicas fundamentadas.

📍 Requisitos funcionais

• Desenvolver em JavaScript e TypeScript (Requisito Fatec).

• O sistema deverá reter dados de planilhas do excel e analisar as vendas por meio de gráficos, contendo funcionalidade de filtragem.

• O sistema deverá ser capaz de calcular a comissão de cada vendendor de acordo com suas respectivas vendas e seus diferentes tipos.

• O sistema deverá conter uma área de login e cadastro para funcionários e gerencia.

• O sistema deverá conter uma interface exclusiva para a gerencia, onde seja possível atribuir maior porcentagem nas comissões de um funcionário.

📍 Requisitos não-funcionais

• Documentação via GitHub.

• Protótipo criado no Figma.

• Modelagem de Banco de Dados.

• Interface responsiva e amigável para facilitar o acesso e a utilização do dashboard em diferentes dispositivos e tamanhos de tela.

• Garantia de desempenho e escalabilidade do sistema, mesmo com grandes volumes de dados de vendas e usuários simultâneos.

🔧 Tecnologias utilizadas

• 

• 

• 

• 

• 

• 

• 

• 

• 

• 

📊 Sprints e Backlog

📊 User Stories

📋 MVP

📁 Diagrama de classes (UML)

📽️ Vídeo final

Vídeo

Videos3S3Sprint.mp4

</div>

Guia de Instalação

Este guia oferece instruções detalhadas sobre como baixar, configurar e executar este projeto em sua máquina local.

Pré-requisitos

Antes de começar, certifique-se de ter os seguintes requisitos instalados em sua máquina:

• Visual Studio Code
• Node.js
• MySQL

Instalação

1. Baixando o projeto

   • Baixe o arquivo zip do projeto no GitHub e extraia-o para uma pasta local em seu computador.
   • Abra a pasta do projeto no Visual Studio Code.

2. Configurando o Banco de Dados

   • Utilize o MySQL para criar um banco de dados chamado upload.
   • No arquivo .env localizado no diretório do projeto, preencha as informações de conexão com o banco de dados, incluindo o nome de usuário e senha.

3. Instalando as dependências

   Abra três terminais no Visual Studio Code:

   • Terminal 1: Frontend (Dashboard)

     cd dashboard
     npm install

   • Terminal 2: Backend

     cd backend
     npm install
     npx sequelize-cli db:migrate

   • Terminal 3: Backend de Acessos

     cd backend_acessos
     npm install
     npm run typeorm -- -d ./src/database/data-source.ts migration:run

Executando o Projeto

Após completar as etapas de instalação, você pode iniciar o projeto executando os seguintes comandos em seus respectivos terminais:

• Terminal 1: Frontend (Dashboard)

  npm run dev

• Terminal 2: Backend

  nodemon app.js

• Terminal 3: Backend_acessos

nodemon app.js