kadughost/manga-rosa-backend

Api para gerenciar contratados de uma empresa

Manga Rosa Backend

Um projeto de gerenciamento de contratados feito em NodeJs, utilizando a biblioteca express e banco de dados MySql. Projeto feito para alimentar o frontend manga-rosa-frontend. Você encontra está aplicação clicando aqui.

Guia de Instalação

Para iniciar o projeto, você precisa utilizar o ambiente MySql que vai servir como banco de dados para este projeto. Você encontra este ambiente clicando aqui.

Após o ambiente MySql devidamento instalado, utilize o seguinte comando para clonar este repositório:

git clone https://github.com/KaduGhost/manga-rosa-backend

Utilize o seguinte comando para ir até a pasta do repositório

cd manga-rosa-backend

Utilize o seguinte comando para instalar as dependências desta aplicação:

npm install

Utilize as seguintes linhas sql para gerar os dados iniciais e tabelas da aplicação

CREATE TABLE IF NOT EXISTS hired (id bigint AUTO_INCREMENT PRIMARY KEY, name varchar(100) not null, email varchar(100) not null, cpf varchar(14) unique not null, phone varchar(11), date_validate bigint default 0, valid boolean);

CREATE TABLE IF NOT EXISTS knowledges(id bigint AUTO_INCREMENT PRIMARY KEY, name varchar(30) not null);

CREATE TABLE IF NOT EXISTS hired_knowledges(id_hired bigint not null, id_knowledges bigint not null, FOREIGN KEY (id_hired) REFERENCES hired(id), FOREIGN KEY (id_knowledges) REFERENCES knowledges(id));

INSERT INTO knowledges (name) VALUES ("Git"), ("React"), ("PHP"), ("NodeJS"), ("DevOps"), ("Banco de Dados"), ("TypeScript")

Crie um arquivo .env com:

PORT=3333
DB_HOST=
DB_USER=
DB_PWD=
DB_NAME=

Preencha o arquivo .env com as informações do banco de dados

Após a instalação das dependências e configuração do arquivo .env, utilize o comando a seguir para iniciar a aplicação:

npm start

Guia de utilização

Este projeto possui 4 rota utilizaveis, veja a descrição delas abaixo.

Rota	Metódo	Descrição
/hired/	get	Está rota serve para buscar todos os contratados
/hired/	post	Está rota serve para cadastrar um novo contratado
/hired/findByName/	get	Está rota serve para buscar apenas um contratado pelo seu nome completo
/hired/	put	Está rota serve para editar o status de validação do contratado

Objeto de deve ser enviado na rota /hired/ utilizando o metódo post

{
    "name": "nome completo aqui",
    "phone": "celular aqui",
    "emai": "email aqui",
    "cpf": "cpf aqui",
    "knowledges": ["Git", "React"]
}

Objeto que deve ser enviado na rota /hired/ utilizando o metódo put

{
    "id": "id do contratado",
    "valid": true, (um booleano informando se o contratado está válido ou não)
    "dateValidate": 0, (um número timestamp)
}

Parametro que deve ser enviado na rota /hired/findByName utilizando o metódo get

"/hired/findByName?name=nome completo do colaborador"

Feito por Carlos Eduardo (KaduGhost)