From 5ae894a91cf06036593e284dde15e0487bf6b7ec Mon Sep 17 00:00:00 2001 From: Vinicius7Codeby Date: Tue, 18 Jul 2023 21:29:44 -0300 Subject: [PATCH] feat: :art: rename documentations folder and update README.md --- README.md | 94 +++++++++++++++++- .../01-software-engineering/01 5W1H.xlsx | Bin ...iness Rules and Requirements Document.docx | Bin .../03 Use Case Diagram.jpg | Bin .../04 Use Case Documentation.docx | Bin .../05 Traceability Matrices.xlsx | Bin .../06 MER (Model Entity Relationship).png | Bin .../02-database/07 Logical Modeling.png | Bin .../02-database/08 Physical Modeling.png | Bin ...9 Electrical Diagram of the Hydrometer.png | Bin .../10 Screens Before Authentication.png | Bin .../04-app/11 Admin Screens.png | Bin .../04-app/12 Customer Screens.png | Bin 13 files changed, 92 insertions(+), 2 deletions(-) rename {documentations => docs}/01-software-engineering/01 5W1H.xlsx (100%) rename {documentations => docs}/01-software-engineering/02 Business Rules and Requirements Document.docx (100%) rename {documentations => docs}/01-software-engineering/03 Use Case Diagram.jpg (100%) rename {documentations => docs}/01-software-engineering/04 Use Case Documentation.docx (100%) rename {documentations => docs}/01-software-engineering/05 Traceability Matrices.xlsx (100%) rename {documentations => docs}/02-database/06 MER (Model Entity Relationship).png (100%) rename {documentations => docs}/02-database/07 Logical Modeling.png (100%) rename {documentations => docs}/02-database/08 Physical Modeling.png (100%) rename {documentations => docs}/03-hydrometer/09 Electrical Diagram of the Hydrometer.png (100%) rename {documentations => docs}/04-app/10 Screens Before Authentication.png (100%) rename {documentations => docs}/04-app/11 Admin Screens.png (100%) rename {documentations => docs}/04-app/12 Customer Screens.png (100%) diff --git a/README.md b/README.md index 9de1592..7d3e21e 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,92 @@ -# tcc-smart-hydrometer -Projeto do Trabalho de Conclusão de Curso (TCC) na Uni-FACEF +# TCC: Smart Hydrometer + +> Trabalho de Conclusão de Curso (TCC) - Uni-FACEF + +Veja o artigo completo [AQUI](/docs/__Article__.pdf) + +## 🎯 Objetivo Geral + +Desenvolver uma solução que auxilie os usuários a **controlar o seu consumo de água**, por meio de um aplicativo para **monitoramento do consumo** e o **valor financeiro** aproximado que o consumo representa. + +## 🔎 Objetivos Específicos + +* **Conscientizar os usuários** da solução por meio de **notícias e dicas** que incentivam a adoção de **boas práticas** para controlar o consumo; + +* Oferecer um **monitoramento de consumo por região**, para conhecer melhor quais pontos da cidade sofrem de **desperdício em abundância** e para que **programas e boas práticas** possam ser tomadas nessas regiões. + +# 📁 Documentações + +**Veja todas as documentações: [AQUI](/docs/)** + +* Engenharia de Software: [AQUI](/docs/01-software-engineering/) + * 5W1H: [AQUI](/docs/01-software-engineering/01%205W1H.xlsx) + * Documento de Requisitos e Regras de Negócio: [AQUI](/docs/01-software-engineering/02%20Business%20Rules%20and%20Requirements%20Document.docx) + * Diagrama do Caso de Uso: [AQUI](/docs/01-software-engineering/03%20Use%20Case%20Diagram.jpg) + * Documentação do Caso de Uso: [AQUI](/docs/01-software-engineering/04%20Use%20Case%20Documentation.docx) + * Matrizes de Rastrabilidade: [AQUI](/docs/01-software-engineering/05%20Traceability%20Matrices.xlsx) + +* Banco de Dados: [AQUI](/docs/02-database/) + * Modelagem Conceitual (MER): [AQUI](/docs/02-database/06%20MER%20(Model%20Entity%20Relationship).png) + * Modelagem Lógica: [AQUI](/docs/02-database/07%20Logical%20Modeling.png) + * Modelagem Física: [AQUI](/docs/02-database/08%20Physical%20Modeling.png) + +* Hidrômetro: [AQUI](/docs/03-hydrometer/) + * Diagrama Elétrico do Hidrômetro: [AQUI](/docs/03-hydrometer/09%20Electrical%20Diagram%20of%20the%20Hydrometer.png) + +* Telas: [AQUI](/docs/04-app/) + * Telas Antes da Autenticação: [AQUI](/docs/04-app/10%20Screens%20Before%20Authentication.png) + * Telas do Administrador: [AQUI](/docs/04-app/11%20Admin%20Screens.png) + * Telas do Cliente: [AQUI](/docs/04-app/12%20Customer%20Screens.png) + +# 💻 Componentes, Tecnologias e Metodologias Utilizadas + +* **[Frontend Mobile](/mobile/)** + * Typescript + * React Native + * Styled Components + +* **[Backend](/server/)** + * Typescript + * NodeJS + * Express + * MQTT + * Prisma ORM + * Background Jobs (Bull) + * Node Cron + * Selenium + * JSON Web Token + * Multer + * Nodemailer + * Swagger UI + * SOLID + +* **[Hidrômetro](/hydrometer/)** + * Arduino IDE + * PubSubClient + * ESP8266 NodeMCU + * Flow Sensor + * 5 Volt Source + +## 🤝 Colaboradores + + + + + + + +
+ + Foto do Vinícius Gabriel no GitHub
+ + Vinícius Gabriel + + + 		+ + Foto do Pedro Marçal no GitHub
+ + Pedro Marçal + + +
diff --git a/documentations/01-software-engineering/01 5W1H.xlsx b/docs/01-software-engineering/01 5W1H.xlsx similarity index 100% rename from documentations/01-software-engineering/01 5W1H.xlsx rename to docs/01-software-engineering/01 5W1H.xlsx diff --git a/documentations/01-software-engineering/02 Business Rules and Requirements Document.docx b/docs/01-software-engineering/02 Business Rules and Requirements Document.docx similarity index 100% rename from documentations/01-software-engineering/02 Business Rules and Requirements Document.docx rename to docs/01-software-engineering/02 Business Rules and Requirements Document.docx diff --git a/documentations/01-software-engineering/03 Use Case Diagram.jpg b/docs/01-software-engineering/03 Use Case Diagram.jpg similarity index 100% rename from documentations/01-software-engineering/03 Use Case Diagram.jpg rename to docs/01-software-engineering/03 Use Case Diagram.jpg diff --git a/documentations/01-software-engineering/04 Use Case Documentation.docx b/docs/01-software-engineering/04 Use Case Documentation.docx similarity index 100% rename from documentations/01-software-engineering/04 Use Case Documentation.docx rename to docs/01-software-engineering/04 Use Case Documentation.docx diff --git a/documentations/01-software-engineering/05 Traceability Matrices.xlsx b/docs/01-software-engineering/05 Traceability Matrices.xlsx similarity index 100% rename from documentations/01-software-engineering/05 Traceability Matrices.xlsx rename to docs/01-software-engineering/05 Traceability Matrices.xlsx diff --git a/documentations/02-database/06 MER (Model Entity Relationship).png b/docs/02-database/06 MER (Model Entity Relationship).png similarity index 100% rename from documentations/02-database/06 MER (Model Entity Relationship).png rename to docs/02-database/06 MER (Model Entity Relationship).png diff --git a/documentations/02-database/07 Logical Modeling.png b/docs/02-database/07 Logical Modeling.png similarity index 100% rename from documentations/02-database/07 Logical Modeling.png rename to docs/02-database/07 Logical Modeling.png diff --git a/documentations/02-database/08 Physical Modeling.png b/docs/02-database/08 Physical Modeling.png similarity index 100% rename from documentations/02-database/08 Physical Modeling.png rename to docs/02-database/08 Physical Modeling.png diff --git a/documentations/03-hydrometer/09 Electrical Diagram of the Hydrometer.png b/docs/03-hydrometer/09 Electrical Diagram of the Hydrometer.png similarity index 100% rename from documentations/03-hydrometer/09 Electrical Diagram of the Hydrometer.png rename to docs/03-hydrometer/09 Electrical Diagram of the Hydrometer.png diff --git a/documentations/04-app/10 Screens Before Authentication.png b/docs/04-app/10 Screens Before Authentication.png similarity index 100% rename from documentations/04-app/10 Screens Before Authentication.png rename to docs/04-app/10 Screens Before Authentication.png diff --git a/documentations/04-app/11 Admin Screens.png b/docs/04-app/11 Admin Screens.png similarity index 100% rename from documentations/04-app/11 Admin Screens.png rename to docs/04-app/11 Admin Screens.png diff --git a/documentations/04-app/12 Customer Screens.png b/docs/04-app/12 Customer Screens.png similarity index 100% rename from documentations/04-app/12 Customer Screens.png rename to docs/04-app/12 Customer Screens.png