## E#Form#Backend

“A verdade do tempo é que tudo passa”!

Objetivo | Sobre o projeto | Test API | Licença

Objetivo:

Requisitos técnicos

Desenvolver usando Javascript
Serviço deve respeitar os princípios RESTFul
Criar um README.md (arquitetura, instruções de uso, entre outros)

Diferenciais

Publicação do ambiente em um serviço cloud de hospedagens (Heroku, AWS, GCP, etc)
Configurar a aplicação para rodar em um container
Documentação da API

🚀 Sobre o projeto

Requisitos:

As ferramentas que você irá encontrar

Aplicação criada do zero usando NestJs, conta com as seguintes ferramentas:

Husky + Concurrently;
ESLint + Prettier + EditorConfig;
TypeORM (PostgreSQL);
Restful;
Swagger + Insomnia;
Jest;
Tests de TDD + e2e;
Outros

NOTA: Todo o projeto está baseado na arquitetura de modulos sugerida pelo Nestjs

Instalação:

yarn

Endpoint Auth

grant_type = refresh_token
  --> refresh_token

grant_type = password_grant
  --> credential
  --> password

grant_type = create_credentials
  --> firstname
  --> lastname
  --> documentNumber
  --> email
  --> phone
  --> password

Tests:

yarn test && yarn test:e2e

Rodando o Projeto:

Este projeto está conteinerizado em Docker, com exceção do nodejs, você não precisa ter instalado localmente o banco de dados integrado ao sistema.

Para subir o docker do projeto rode:

docker-compose up

NOTA: o projeto conta com todas as configurações realizadas a partir de variáveis ambiente. Você deve criar um arquivo .env a partir do .env.sample já existente no projeto.

➿ Test API

Este projeto possui sua api documentada com swagger bastanto para tal acessar a rota http://localhost:3333/api/

📝 Licença

Esse projeto está sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.

carvalhoviniciusluiz/eform-backend