Skip to content

[Docs] Adiciona documentação mais detalhada do projeto - #491

Open
diraol wants to merge 1 commit into
mainfrom
dro/docs
Open

[Docs] Adiciona documentação mais detalhada do projeto#491
diraol wants to merge 1 commit into
mainfrom
dro/docs

Conversation

@diraol

@diraol diraol commented Jul 30, 2025

Copy link
Copy Markdown
Contributor

Disclaimer: Esta documentação foi gerada usando uma ferramenta de inteligência articial (cloud-4-opus).

Disclaimer: Esta documentação foi gerada usando uma ferramenta de
inteligência articial (cloud-4-opus).
@diraol
diraol requested a review from a team as a code owner July 30, 2025 19:52
@sonarqubecloud

Copy link
Copy Markdown

Comment thread docs/01-arquitetura.md
O app usa [MobX](https://pub.dev/packages/mobx) para gerenciamento reativo de estado:

- **Stores** - Mantêm o estado da aplicação
- **Actions** - Modificam o estado

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- **Actions** - Modificam o estado
- **Actions** - Modifica o valor dos observables de forma rastreável

Comment thread docs/01-arquitetura.md

- **Stores** - Mantêm o estado da aplicação
- **Actions** - Modificam o estado
- **Computed values** - Estado derivado

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- **Computed values** - Estado derivado
- **Computed values** - Deriva automaticamente valores a partir de observables (renderiza widget com o novo valor sempre que store.value for alterado)

Comment thread docs/01-arquitetura.md
- **Stores** - Mantêm o estado da aplicação
- **Actions** - Modificam o estado
- **Computed values** - Estado derivado
- **Reactions** - Efeitos colaterais

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- **Reactions** - Efeitos colaterais
- **Reactions** - Efeitos colaterais automáticos quando observables mudam

Comment thread docs/01-arquitetura.md

### 4. Navegação

A navegação é gerenciada através do sistema de roteamento do Flutter Modular:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
A navegação é gerenciada através do sistema de roteamento do Flutter Modular:
A navegação é gerenciada através do sistema de roteamento do [Flutter Modular] (https://pub.dev/packages/flutter_modular):

Comment thread docs/01-arquitetura.md
3. **MobX para Estado** - Fornece programação reativa com mínimo boilerplate
4. **Padrão Repository** - Abstrai fontes de dados da lógica de negócio
5. **Padrão Use Case** - Encapsula regras de negócio e fluxos de trabalho

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
6. **Teste de unidade** - Garante que funcionalidades continuem funcionando mesmo após alterações de código entre outros Benefícios.
7. **Teste de widget** - Garante que não teve alterações no design da tela ao alterar código.


### `error/`
- `failures.dart` - Classes de falha customizadas
- Tratamento centralizado de erros

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Tratamento centralizado de erros
- `exceptions.dart` - Classes de exception customizadas
- `api_provider_error_mapper.dart` - Mapeia erros recebidos da api para a classe failure apropriada
- Tratamento centralizado de erros

### `network/`
- `api_client.dart` - Cliente HTTP configurado
- `api_server_configure.dart` - Configuração do servidor
- `network_info.dart` - Informações de conectividade

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- `network_info.dart` - Informações de conectividade
- `api_content_type.dart` - Retorna o tipo de conteúdo da API (json, formUrlEncoded)
- `api_http_request_method.dart` - enum com o tipo do método http


### `remoteconfig/`
- `i_remote_config.dart` - Interface para Remote Config
- `remote_config.dart` - Implementação Firebase Remote Config

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- `remote_config.dart` - Implementação Firebase Remote Config
- `remote_config.dart` - Implementação Firebase Remote Config
- `remote_config_keys.dart` - Classe responsável pelas keys do Remote Config


### `states/`
- Estados globais da aplicação
- Enums e tipos compartilhados

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Enums e tipos compartilhados

```
storage/
├── cache_storage.dart # Interface para cache
├── i_local_storage.dart # Interface para storage local

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
├── i_local_storage.dart # Interface para storage local
├── collection_store.dart # Store para Collection
├── i_local_storage.dart # Interface para storage local

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants