Introdução 📖

Após 9 meses de curso no devinHouse, chegamos neste desafio final. O projeto final consiste em desenvolver uma API para gerenciar IOTs de fazendas inteligentes.

O Projeto foi feito em grupo, com 4 integrantes. O grupo foi composto por:

• Eu (Marcelo);
• Francisko;
• Eduarda;
• Théo;

A API foi desenvolvida utilizando o framework Nest.js, com o banco de dados Postgres e o ORM Typeorm. A documentação da API foi feita utilizando o Swagger com a especificação Openapi 3.0.0.

Print da introdução ao projeto 🎞

Sumário 📑

• Tecnologias 💻
• Pré-requisitos recomendáveis 🛠️
• Como usar 🤔
• Banco de dados 🗄️
• Features 📌
• Swagger 📚
• Apresentação

Tecnologias 💻

- Node; 🟩
- Nest.js; 🟪
- Typeorm; 🗄️
- Swagger 📖
- Postgres; 🐘

Pré-requisitos recomendáveis 🛠️

• Node.js - Versão 18.15.0
• Postgres instalado e rodando na porta 5432

Como usar 🤔

Para usar o projeto, siga as seguintes etapas:

Instruções em texto

1. Criar o database no Postgres, para utilizar no projeto;

2. Utilizar o comando `npm install` para instalar as dependências;

3. Utilizar o `.env_example` como base para o `.env` e colocar as suas configurações;

4. Utilizar o comando `npm run migration:run` para criar as tabelas após a configuração das variáveis de ambiente no passo 3

5. Utilizar o comando `npm run start:dev` para executar a aplicação no ambiente de desenvolvimento.

Banco de dados 🗄️

O banco de dados utilizado foi o Postgres, com o ORM Typeorm. O banco de dados possui 5 tabelas: Companies, Locations, Sensors, Measurements, avaliable_sensors

Features Especiais 📌

Arquitetura da Documentação do Swagger bem planejada e executada;

Controller:

DTO:

JWT;

Seed;

CRON Jobs;

Swagger 📚

A documentação da API utiliza Swagger com a especificação Openapi 3.0.0, na rota /api-docs.

Swagger 📖

Imagem overview do Swagger

Imagem de um método do Swagger

---

Apresentação

Acesse nossa apresentação aqui