Documentação para Desenvolvedores

Bem-vindo à documentação técnica do Stock. Este documento serve como um guia centralizado para desenvolvedores que desejam entender a arquitetura, manter e contribuir para este projeto de gerenciamento de estoque de medicamentos.

Download da Aplicação

Faça o download da versão estável mais recente do Stock para testar as funcionalidades em seu dispositivo antes de começar a desenvolver.

Galeria do Projeto

Uma visão rápida da interface do usuário do Stock em ação. As imagens abaixo mostram as principais telas e funcionalidades da aplicação.

Dashboard com Gráfico de Estoque

Dashboard com Drawer

Formulário de Cadastro de Medicamentos

Lisgatem de medicamentos no estoque

Detalhes e Histórico de Uso

Exportação de Relatório em PDF

Primeiros Passos

Para configurar o ambiente e executar o projeto, siga os passos abaixo. Certifique-se de ter o Flutter SDK instalado.

1. Clone o repositório:
   

   git clone https://github.com/ezequielvieira/Stock.git
   cd Stock

2. Instale as dependências:
   

   flutter pub get

3. Execute os geradores de código:
   

   Este comando é crucial para gerar os adaptadores do Hive a partir dos modelos.

   flutter pub run build_runner build --delete-conflicting-outputs

4. Execute o aplicativo:
   

   Selecione o dispositivo desejado e execute o comando:

   flutter run

Arquitetura e Estrutura do Projeto

O projeto adota uma arquitetura limpa com separação de responsabilidades para facilitar a manutenção. A estrutura de diretórios em lib/ é organizada da seguinte forma:

Gerenciamento de Estado com Provider

Utilizamos o pacote provider para o gerenciamento de estado. A classe MedicamentoProvider (`lib/provider/medicamento_provider.dart`) é o coração dessa arquitetura, centralizando a lógica e notificando a UI sobre as alterações.

// Exemplo simplificado: lib/provider/medicamento_provider.dart
import 'package:flutter/material.dart';
import '../models/medicamento.dart';
import '../services/hive/hive_manager.dart';

class MedicamentoProvider with ChangeNotifier {
  final HiveManager _hiveManager = HiveManager();
  List _medicamentos = [];

  List get medicamentos => _medicamentos;

  Future loadMedicamentos() async {
    _medicamentos = await _hiveManager.getMedicamentos();
    notifyListeners();
  }

  Future addMedicamento(Medicamento medicamento) async {
    await _hiveManager.addMedicamento(medicamento);
    await loadMedicamentos(); // Recarrega para garantir consistência
  }
}

Persistência de Dados com Hive

Para armazenamento local, o projeto utiliza o hive. A interação com o banco é abstraída na camada de serviços para desacoplar a lógica de negócio da implementação do banco de dados.

// Anotações no modelo para geração do adapter
import 'package:hive/hive.dart';

part 'medicamento.g.dart'; // Arquivo gerado pelo build_runner

@HiveType(typeId: 0) // Identificador único para o tipo
class Medicamento extends HiveObject {
  @HiveField(0) // Identificador único para o campo
  late String id;

  @HiveField(1)
  late String nome;
  
  // ... outros campos anotados
}

Dependências Principais

Uma visão geral das dependências mais importantes do projeto, definidas em pubspec.yaml.

Licença e Termos de Contribuição

Ao contribuir com o projeto Stock, você concorda que suas contribuições estarão licenciadas sob os termos descritos abaixo. É fundamental ler e entender este acordo antes de submeter qualquer código.

Como Contribuir

Interessado em fazer parte do projeto? Sua contribuição é muito bem-vinda! Como o repositório no GitHub é privado, o primeiro passo é solicitar o acesso para que possamos te adicionar como colaborador.

Processo de Desenvolvimento

Após ter seu acesso liberado, siga estas diretrizes:

Apoie o Projeto

Se você gosta do Stock e ele é útil para você, considere apoiar o projeto com uma doação. Sua ajuda é fundamental para cobrir os custos de desenvolvimento e nos motiva a continuar evoluindo a aplicação. Toda contribuição, de qualquer valor, é muito bem-vinda!