Conecta Café

   _____                                 _                _____            __        
  / ____|                               | |              / ____|          / _|       
 | |        ___    _ __     ___    ___  | |_    __ _    | |        __ _  | |_    ___ 
 | |       / _ \  | '_ \   / _ \  / __| | __|  / _` |   | |       / _` | |  _|  / _ \
 | |____  | (_) | | | | | |  __/ | (__  | |_  | (_| |   | |____  | (_| | | |   |  __/
  \_____|  \___/  |_| |_|  \___|  \___|  \__|  \__,_|    \_____|  \__,_| |_|    \___|

✅ Concluído ✅

Para documentação dos endpoints, acesse o Swagger em api/doc.

☕ Sobre o projeto

• 🤖 API
• 📟 Web

API Rest do projeto Conecta Café, criada para o trabalho de conclusão de curso (TCC) do curso de Engenharia de computação do Instituto Nacional de Telecomunicações (INATEL).

---

💻 Tecnologias

As principais tecnologias utilizadas na construção do projeto:

• NestJS
• TypeORM
• Docker
• PostgreSQL
• Jest

Obtenha mais detalhes no arquivo package.json

Utilitários

• Editor: Visual Studio Code
• Teste de API: Insomnia

---

👨‍💻 Como executar o projeto

💡 Pré-requisitos

Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas: Git, Node.js e Docker.

1. Clone o repositório

git clone https://github.com/Brendhon/conecta-cafe-api.git

2. Inicie o Banco de dados.

Para evitar que seja necessário a instalação do PostgresSQL na sua máquina, vamos utilizar uma imagem Docker. Foi criado um script create-db.sh para automatizar o processo, execute-o com o comando:

npm run create:db

Obs: Para utilizar esse comando é necessário que ele seja executado em um Shell terminal, ou seja, utilize terminais como bash e PowerShell para que seja possível executar o comando sh.

3. Instale as dependências

npm install

4. Com isso o projeto já estará pronto para ser executado.

Observações:

• Foi criado um script para apagar o container do postgres no docker, utilize o comando:

  npm run delete:db

• Caso já possua a imagem docker (conecta_cafe_server) criada, é possível iniciar o container com o comando:

  npm run start:db

• O mesmo que foi dito sobre o comando npm run create:db vale para os dois comandos acima;
• Foi criado um arquivo Insomnia - Conecta Café.json contendo os testes das requisições, para adiciona-la, basta ir no Insomnia e importar coleção.

⚽ Rodando o servidor

Execute a aplicação em modo de desenvolvimento

npm run start:dev

O servidor iniciará em localhost:3333.

🤖 Rodando os testes automatizados

Executar os testes unitários:

npm run test

Executar os testes e2e (End to end):

npm run test:e2e

É possível gerar uma pagina html para visualizar a cobertura de código:

• Gerar cobertura dos testes unitários:

npm run cov:unit 

• Gerar cobertura dos testes e2e:

npm run cov:e2e 

---

👥 Autores

Brendhon Moreira

Gabriel Daniel

Moises Delmoro

Contato

---

📝 License

• MIT license