feat: 🎨 rename documentations folder and update README.md

Vini7Dev · Jul 19, 2023 · 5ae894a · 5ae894a
1 parent dd64453
commit 5ae894a
Show file tree

Hide file tree

Showing 13 changed files with 92 additions and 2 deletions.
diff --git 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
+
+<table>
+  <tr>
+    <td align="center">
+      <a href="https://github.com/Vini7Dev">
+        <img src="https://avatars3.githubusercontent.com/u/94920663" width="100px;" alt="Foto do Vinícius Gabriel no GitHub"/><br>
+        <sub>
+          <b>Vinícius Gabriel</b>
+        </sub>
+      </a>
+    </td>
+
+    <td align="center">
+      <a href="https://github.com/PedroSMarcal">
+        <img src="https://avatars.githubusercontent.com/u/62404639" width="100px;" alt="Foto do Pedro Marçal no GitHub"/><br>
+        <sub>
+          <b>Pedro Marçal</b>
+        </sub>
+      </a>
+    </td>
+  </tr>
+</table>
diff --git a/...ions/01-software-engineering/01 5W1H.xlsx → docs/01-software-engineering/01 5W1H.xlsx b/...ions/01-software-engineering/01 5W1H.xlsx → docs/01-software-engineering/01 5W1H.xlsx
diff --git a/...ness Rules and Requirements Document.docx → ...ness Rules and Requirements Document.docx b/...ness Rules and Requirements Document.docx → ...ness Rules and Requirements Document.docx
diff --git a/...tware-engineering/03 Use Case Diagram.jpg → ...tware-engineering/03 Use Case Diagram.jpg b/...tware-engineering/03 Use Case Diagram.jpg → ...tware-engineering/03 Use Case Diagram.jpg
diff --git a/...ngineering/04 Use Case Documentation.docx → ...ngineering/04 Use Case Documentation.docx b/...ngineering/04 Use Case Documentation.docx → ...ngineering/04 Use Case Documentation.docx
diff --git a/...engineering/05 Traceability Matrices.xlsx → ...engineering/05 Traceability Matrices.xlsx b/...engineering/05 Traceability Matrices.xlsx → ...engineering/05 Traceability Matrices.xlsx
diff --git a/...se/06 MER (Model Entity Relationship).png → ...se/06 MER (Model Entity Relationship).png b/...se/06 MER (Model Entity Relationship).png → ...se/06 MER (Model Entity Relationship).png
diff --git a/...tions/02-database/07 Logical Modeling.png → docs/02-database/07 Logical Modeling.png b/...tions/02-database/07 Logical Modeling.png → docs/02-database/07 Logical Modeling.png
diff --git a/...ions/02-database/08 Physical Modeling.png → docs/02-database/08 Physical Modeling.png b/...ions/02-database/08 Physical Modeling.png → docs/02-database/08 Physical Modeling.png
diff --git a/... Electrical Diagram of the Hydrometer.png → ... Electrical Diagram of the Hydrometer.png b/... Electrical Diagram of the Hydrometer.png → ... Electrical Diagram of the Hydrometer.png
diff --git a/...-app/10 Screens Before Authentication.png → ...-app/10 Screens Before Authentication.png b/...-app/10 Screens Before Authentication.png → ...-app/10 Screens Before Authentication.png
diff --git a/documentations/04-app/11 Admin Screens.png → docs/04-app/11 Admin Screens.png b/documentations/04-app/11 Admin Screens.png → docs/04-app/11 Admin Screens.png
diff --git a/...mentations/04-app/12 Customer Screens.png → docs/04-app/12 Customer Screens.png b/...mentations/04-app/12 Customer Screens.png → docs/04-app/12 Customer Screens.png