/challenge-dr-consulta

Primary LanguageTypeScript

Parking Management Api

Índice

Sobre

Challenge Dr. Consulta.

Api criada para o gerenciamento das vagas das empresas cadastradas.

Tecnologias

Iniciando

Pré-requisitos

  • Docker instalado

    https://www.docker.com/

  • Docker Compose instalado

    https://docs.docker.com/compose/

Uso

1 - Após ter o docker e o docker-compose instalados em sua máquina execute a api executando o comando abaixo no terminal:

  docker-compose up app

2 - Após a execução do comando aguarde a aplicação iniciar, primeiramente será criada a base de dados, após isso as migrations serão geradas e por fim a api ira iniciar.

3 - Quando receber a mensagem no terminal "App running on port 3000" a api estará rodando.

4 - A api estará acessivel no Link e o link do swagger estará disponível Aqui

5 - As collections e env's para execução no postman estão disponiveis no diretório deste projeto na pasta collections.

OBS: É criado por default um usuário com perfil de Admin, onde o email é user@gmail.com e a senha 1234.

OBS²: Os endpoints precisam estar autenticados com o token gerado pela rota /users/signin, presente nas collections, ao executar este endpoint ele salvará o token nas env's.

Testes

Execução dos testes automatizados

1 - Para execução dos testes automatizados, execute o comando abaixo no terminal para execução do container de testes:

  docker-compose run tst bash

2 - Após carregar o container de teste execute os comandos abaixo para criação da base de teste e execução das migrations:

  npm run db:create && npm run db:migrate

3 - Por fim uma vez criada a base de dados, execute o comando abaixo para execução dos testes automatizados:

  npm run test

OBS: Não foram criados ainda todos os testes de feature/unit os mesmos estão em WIP.

Glauber Oliveira - Linkedin - glauber17230@gmail.com