Este projeto é uma aplicação Flutter que fornece informações sobre os Golden Raspberry Awards, um evento anual que premia os piores filmes do ano. A aplicação consulta uma API para obter dados sobre filmes, estúdios, produtores e anos com múltiplos vencedores.
- Listagem de filmes, incluindo vencedores e indicados.
- Exibição de estúdios com o maior número de vitórias.
- Informações sobre produtores com os maiores e menores intervalos entre vitórias.
- Anos que tiveram mais de um filme vencedor.
O relatório de cobertura do código pode ser encontrado aqui: Coverage Report
Uma versão web para testes está disponível em: Golden Raspberry Awards Web App
Uma versão web para testes está disponível em: app-release.apk
Aqui estão algumas imagens das telas principais da aplicação:
O projeto segue a arquitetura de domínio limpo (Clean Architecture), organizada da seguinte maneira:
- Domain: Contém as entidades do negócio, use cases e a interface do repositório.
- Data: Implementação dos repositórios e fontes de dados (API, banco de dados local, etc.).
- Presentation: UI e lógica de apresentação, utilizando o padrão de design bloc.
- Clone o repositório para sua máquina local.
- Abra o projeto em seu ambiente de desenvolvimento Flutter.
- Instale todas as dependências executando
flutter pub get
. - (Opcional) Gere os arquivos de mock para testes com
flutter pub run build_runner build
.
Para executar os testes unitários, use o seguinte comando:
flutter test
Claro, aqui está a seção solicitada para adicionar ao seu README.md
:
Para executar a aplicação no Flutter, siga os seguintes passos:
- Certifique-se de ter o Flutter instalado em sua máquina.
- Um emulador ou dispositivo físico para executar a aplicação.
-
Clone o Repositório: Clone o repositório da aplicação para a sua máquina local usando:
git clone <URL_DO_REPOSITORIO>
Substitua
<URL_DO_REPOSITORIO>
pelo URL do seu repositório. -
Instale as Dependências: Navegue até o diretório do projeto e execute o seguinte comando para instalar as dependências necessárias:
flutter pub get
-
Defina a Variável de Ambiente
API_BASE_PATH
: Para executar a aplicação, você precisa definir o caminho base da API. Use a flag--dart-define
para isso. Execute o comando:flutter run --dart-define=API_BASE_PATH="SEU_CAMINHO_DA_API"
Substitua
SEU_CAMINHO_DA_API
pelo caminho da sua API. -
Execute a Aplicação: A aplicação será iniciada no seu emulador ou dispositivo. Agora você pode interagir com a aplicação Flutter.
Sinta-se à vontade para contribuir com o projeto. Antes de fazer um pull request, certifique-se de escrever testes para as novas funcionalidades ou correções.
O projeto está organizado da seguinte maneira:
lib/domain
: Contém as entidades, use cases e interfaces de repositório.lib/data
: Implementações dos repositórios, fontes de dados e modelos de dados.lib/presentation
: Widgets, telas e lógica de apresentação.test
: Testes unitários e de integração.
Lista de principais dependências usadas no projeto:
flutter_bloc
: Gerenciamento de estado e lógica de negócios.dartz
: Trabalho com Either para lidar com falhas e sucessos de maneira funcional.mockito
: Criação de mock objects para testes.http
: Realizar chamadas de API.
Este documento refere-se à versão 1.0.0 do projeto.
- [Renato Augusto Bosa Filho] - Desenvolvedor Inicial - [[email protected]]
- Fork o Projeto: Faça um fork do repositório e clone-o para o seu ambiente de desenvolvimento local.
- Crie uma Branch: Para novas funcionalidades ou correções, crie uma branch baseada na branch
main
. - Faça suas Alterações: Implemente suas alterações, adicione testes e documente qualquer mudança no
README.md
, se necessário. - Execute os Testes: Certifique-se de que todos os testes estão passando.
- Envie um Pull Request: Envie um pull request para a branch
main
. Inclua uma descrição detalhada das mudanças e por que elas são necessárias.