Projeto API - 4 º Semestre

Índice

Mostrar Índice Completo

• Objetivo
• Requisitos funcionais
• Requisitos não-funcionais
• Tecnologias Utilizadas
• Backlog e User Stories
• Diagramas
• Protótipo Figma
• Vídeos das Sprints
• Guia de Instalação

🎯 Objetivo

Desenvolver um sistema Web com regra de negócio complexa em ambiente de produção (Deploy), com foco em processos de trabalho, fluxos de trabalho e colaboração entre equipes, para a empresa JJM Log.

📍 Requisitos funcionais

• Desenvolver em JavaScript e TypeScript (Requisito Fatec).

• O sistema deverá implementar junções de padrões como o MVC (Requisito Fatec).

• O sistema deverá ter interfaces com foco em processos de trabalho, fluxos de trabalho e colaboração entre equipes.

📍 Requisitos não-funcionais

• Documentação via GitHub.

• Protótipo criado no Figma.

• Modelagem de Banco de Dados.

• Interface responsiva.

🔧 Tecnologias utilizadas

📊 Backlog e User Stories

• Acesse o link do Backlog e da User Stories [Clique aqui]

📁 Diagramas

Modelo Conceitual

Modelo Lógico

MVC

🖼 Protótipo Figma

https://www.figma.com/design/cLvxtdAwY5JHZP9VonyJeV/dashboard-(Copy)?node-id=0-1&t=DR6TnYwYdQLy0fZv-1

📽️ Vídeos das Sprints

Ver todos os vídeos das sprints

SPRINT 1 - Assistir ao vídeo da Sprint 1

video-sprint1.mov

---

SPRINT 2 - Assistir ao vídeo da Sprint 2

VideoSprint2Semestre4.mp4

---

SPRINT 3 - Assistir ao vídeo da Sprint 3

VideoSprint3S4.mp4

---

SPRINT 4 - O vídeo da Sprint 4 ainda não foi adicionado.

⬇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

• VSCode: Editor de código para visualização e edição do projeto. Baixe o VSCode
• MySQL: Banco de dados para armazenar informações necessárias ao sistema. Baixe o MYSQL

---

Instalação

1. Baixando o Projeto

• No repositório do GitHub, clique em "Code" e selecione "Download ZIP" ou Clique aqui.
• Localize o arquivo ZIP baixado e extraia-o para uma pasta de sua escolha.

2. Abrindo o Projeto no VSCode

• Inicie o VSCode.
• Clique em File > Open Folder... e selecione a pasta extraída para abrir o projeto.

---

Passos para Executar o Backend

1. Configuração do Banco de Dados

Inicie o MySQL e crie um database chamado wecollab.

create database wecollab;

2. Configuração de Credenciais no Projeto

No arquivo data-source.ts que está localizado em backend/src/database/data-source.ts, adicione a senha do seu MySQL no campo password para conectar ao banco de dados.

password: " ", #coloque a senha do seu MySQL entre as aspas

3. Preparação do Projeto no VSCode

Abra o terminal no VSCode e navegue até a pasta do backend:

cd backend

4. Instalação de Dependências

No terminal, instale as dependências do projeto:

npm install

5. Executando as Migrations

Aplique as migrations para configurar as tabelas no banco de dados:

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

6. Inserindo Dados no Banco

No MySQL, execute os scripts de inserção de dados localizados na pasta database/banco para configurar o banco. Acesse o aruqivo banco

7. Iniciando o Servidor Backend

Inicie o servidor backend com o comando:

npm run dev:server

---

Passos para Executar o Frontend

1. Abrindo um Novo Terminal

Abra um novo terminal no VSCode para configurar o frontend.

2. Configuração e Execução do Frontend

Navegue até a pasta do frontend:

cd frontend

Instale as dependências do frontend:

npm install

Inicie o frontend com o comando:

npm run dev

3. Acessando a Aplicação

No terminal, copie o link que aparece e abra-o no navegador de sua preferência para acessar a aplicação.