docs: update project documentation to include detailed Room entities, sync flow, and README execution guide
This commit is contained in:
40
README.md
40
README.md
@@ -1,21 +1,33 @@
|
||||
<div align="center">
|
||||
<img width="1200" height="475" alt="GHBanner" src="https://ai.google.dev/static/site-assets/images/share-ais-513315318.png" />
|
||||
</div>
|
||||
# Aplicativo de Gestão de Manutenção de Parada (Android)
|
||||
|
||||
# Run and deploy your AI Studio app
|
||||
Aplicativo Android **offline-first** desenvolvido em Kotlin e Jetpack Compose para gerenciamento, acompanhamento e auditoria de Ordens de Serviço (OS) em plantas industriais.
|
||||
|
||||
This contains everything you need to run your app locally.
|
||||
---
|
||||
|
||||
View your app in AI Studio: https://ai.studio/apps/d5626d9c-db6d-4067-9ba1-e80d37ea164f
|
||||
## 📚 Documentação Técnica do Projeto
|
||||
|
||||
## Run Locally
|
||||
- **[Documentação de Fluxo de Dados, Salvamento e Sincronização](file:///home/cesarjhony/dev/projects/gestao_de_manutencao/documentacao/fluxo_de_dados_e_sincronizacao.md)**:
|
||||
- Estrutura completa das 6 tabelas do banco de dados local Room (`maintenance_activities`, `os_findings`, `os_update_history`, `app_logs`, `sync_conflict_logs`, `user_access`).
|
||||
- Fluxo detalhado de salvamento de progresso e achados com tipo exclusivo `FOTO`.
|
||||
- Processo de compactação (<= 500KB) e upload para Firebase Storage.
|
||||
- Sincronização bidirecional com Google Sheets (abas `project`, `history` e `achados`).
|
||||
- Carregamento e download de fotos **sob demanda** (On-Demand Loading) para múltiplos celulares sem erros HTTP 403.
|
||||
|
||||
**Prerequisites:** [Android Studio](https://developer.android.com/studio)
|
||||
- **[Arquitetura do Sistema](file:///home/cesarjhony/dev/projects/gestao_de_manutencao/documentacao/arquitetura/arquitetura_do_sistema.md)**:
|
||||
- Diagramas de arquitetura MVVM + Repository Pattern.
|
||||
- Mapeamento de componentes Compose, ViewModel e Room DAO.
|
||||
- Algoritmo de reconciliação de dados e auditoria transacional.
|
||||
|
||||
---
|
||||
|
||||
1. Open Android Studio
|
||||
2. Select **Open** and choose the directory containing this project
|
||||
3. Allow Android Studio to fix any incompatibilities as it imports the project.
|
||||
4. Create a file named `.env` in the project directory and set `GEMINI_API_KEY` in that file to your Gemini API key (see `.env.example` for an example)
|
||||
5. Remove this line from the app's `build.gradle.kts` file: `signingConfig = signingConfigs.getByName("debugConfig")`
|
||||
6. Run the app on an emulator or physical device
|
||||
## 🚀 Como Executar o Projeto
|
||||
|
||||
**Pré-requisitos:** [Android Studio](https://developer.android.com/studio) / JDK 17+
|
||||
|
||||
1. Abra o Android Studio.
|
||||
2. Selecione **Open** e escolha a pasta deste projeto (`gestao_de_manutencao`).
|
||||
3. Execute os testes unitários via linha de comando ou terminal do estúdio:
|
||||
```bash
|
||||
./gradle_9_3_1/gradle-9.3.1/bin/gradle test
|
||||
```
|
||||
4. Execute o aplicativo em um emulador ou dispositivo físico Android.
|
||||
|
||||
Reference in New Issue
Block a user