/challenge-zoox-api

Primary LanguageTypeScript

CHALLENGE ZOOX

Descrição

Oi! Essa é uma API criada para o teste técnico da ZOOX

Como rodar o projeto?

Para iniciar o projeto, eu recomendo que você siga as inscrições deste repositório.

Caso queira rodar por aqui, esses são os passos que você deve seguir:

  • Renomeie o arquivo example.env para .env e preencha as chaves que agora estão em branco. Aqui vai um exemplo de arquivo preenchido: 
      MONGODB_URI=mongodb://mongodb:27017/challenge_zoox
  PORT=3000
  SECRET=secret
  • Rode o comando npm install ou yarn
  • Para rodar a versão de desenvolvimento, utilize npm run start:dev ou yarn run start:dev

Como rodar os testes

  • Instale as dependências do projeto (você pode utilizar npm install ou yarn)
  • Rode o comando npm run test ou yarn run test

Preview

Você pode ver um swagger da aplicação rodando aqui.

Dúvidas ou sugestões?

Me mande um e-mail :)