Este repositório contém o código do desafio de uma vaga da Allugator. Seguem as instruções abaixo para que possa ser rodado
git clone https://github.com/MatheusDev-1/allugator-challenge.git
Host: localhost
Port: 5432
Database: postgres
USER: postgres
PASSWORD: seeyoulateralligator
docker run --name allugator -e POSTGRES_PASSWORD=seeyoulateralligator -d -p 5432:5432 postgres
Instalar DBEAVER (https://dbeaver.io/download/)
Inicializar e criar nova conexão com banco de dados (Banco de dados -> Nova Conexão de Bancos -> PostgreSQL)
Rodar script para instalar extensão "uuid-ossp", responsável por gerar automaticamente os uuids no banco (sem ela não é possível criar as tabelas)
Editor de SQL -> Novo editor de SQL
create extension if not exists "uuid-ossp";
cd allugator-challenge/backend && yarn
yarn dev:server (após finalizar a instalação de todas as dependências)
yarn typeorm migration:run (para criar todas as tabelas no banco)
http://localhost:3333
cd allugator-challenge/frontend && yarn
yarn start (após finalizar a instalação de todas as dependências)
Na tela /workers, carregar arquivo .csv que está em allugator-challenge/backend/tmp/funcionarios.csv
http://localhost:3000
| Dependência | Função |
|---|---|
| cors | Serve para habilitar o CORS em nosso servidor e permitir determinadas requisições do backend |
| date-fns | Utilizado para formatar datas da melhor forma possível |
| express | Framework para construir aplicações e API's |
| multer | Utilizado para o upload de arquivos |
| pg | Driver do PostgreSQL |
| typeorm | Usado para abstrair queries de banco de dados através de javascript |
| uuidv4 | Geração de UUID para ID dos parâmetros de rotas e banco de dados |
| eslint | Linter para monitoramento do código e indicação de erros |
| prettier | Formatador de código, deixando-o padronizado |
| ts-node-dev | Permite a inicialização com Typescript, fazendo a conversão dos arquivos .js |
| react | Biblioteca componentizada e flexível para criação de interfaces |
| typescript | Superset da linguagem JavaScript, permite a utilização de tipagem estática |
| styled-components | Permite utilização do CSS em JS |
| Método | Rota | Descrição | Tipo de Parâmetro | Parâmetros |
|---|---|---|---|---|
| GET | /worker | Retorna todos os funcionários da planilha | Query String | name, cpf, role, status, minSalary, maxSalary, createdDate |
| GET | /worker/groupedByUf | Retorna quantidade de funcionários e funcionários por UF | ||
| POST | /worker | Cria novo funcionário | Body | name, cpf, role, salary, uf |
| POST | /worker/import | Importa funcionários a partir de arquivo | Multipart-Form | file |
| DELETE | /worker/:cpf | Delete funcionário | Param String | cpf |
Exemplos de features que colocaria na aplicação caso tivesse maior prazo de entrega
- Mapa com marcação dos funcionários por estado
- Hooks e Context API
- Animações quando houvesse inserções/remoções de dados na tabela
- Rotas de update para todos os campos no backend