/survey-api

Primary LanguageTypeScript

Survey API

Survey api é uma aplicação que permite usuários serem criados, autenticados e disponibiliza os mesmo criarem enquentes e responder elas.

📋 Pré-requisitos

Você precisa ter instalado:

  • NodeJS 14.15.x | | maior

  • Docker

  • Mongodb 4.2.x | | maior

🔧 Instalação

Com os pré-requisitos instalados na pasta raiz do projeto, mesmo diretório deste arquivo.

Execute em seu terminal:

npm install

Para instalar as dependências do projeto

🚇 Executando o projeto local

Na raiz do projeto execute:

Para iniciar o projeto

npm run start:local

O projeto ira ser executado na porta http://localhost:5050/.

⚙️ Executando os testes

Execute:

  • npm run test para rodar todos os testes da aplicação
  • npm run test:unit para rodar todos os testes unitários
  • npm run test:integration para rodar todos os testes de integração
  • npm run test:verbose para rodar todos os testes da aplicação com as flags --silent e --noStackTrace desabilitadas
  • npm run test:watch ira apenas executar os testes que você alterar ou os testes que referenciam o código de produção que você alterou
  • npm run test:ci para rodar todos os testes da aplicação e gerar o arquivo de relatório de cobertura de teste

📦 Documentação

Arquitetura do projeto

Swegger do projeto:

  • Inicia aplicação local: npm run start:local
  • Visite a rota: http://localhost:5050/api-docs/

Diagrama de classes

🎁 Melhorias?

Sinta-se 100% livre para abrir um pull request a ideia que este projeto seja vivo e sempre atualizado 🤓.

⌨️ com ❤️ por Gabriel Piazza 😊