mrverdant13 / flutter_my_starred_repos

A demo app project made with Flutter for personal favorites GitHub repos management

Karlo Verde 💙 🇵🇪

Software Developer

I am a Software Developer at Very Good Ventures 🦄 and a Flutter 💙 mentor.

I love programming 👨🏻‍💻, playing guitar 🎸, and teaching 👨🏻‍🏫.

My Open Spource Projects

• Coverde:
  A CLI for basic coverage trace files (lcov.info) manipulation.
  Validate minimum coverage, filter trace files data by tested file paths and generate HTML coverage reports.
• Altoke App:
  An opinionated Flutter app template.
  Create a new Flutter project with a pre-set architecture and implemented common features.

My latest presentations

• Internacionalización de aplicaciones Flutter
• Creación de CLIs en Dart
• Monitoreo de errores con Sentry
• NestJs - Microservicios - MQTT para IoT

My GitHub stats

flutter_my_starred_repos's Issues

build: add iOS flavors

Description

As described in #9, flavors provide a way to develop, test and deploy the app without conflicts with other development stages and with isolated resources, scopes and configuration.

The minimum recommended flavors are:

• Development
• Staging
• Production

Requirements

• Implement development, staging and production flavors.
• Use different app ID per flavor.
• Use different app label per flavor.
• Use different app icon per flavor.
• The build system is passing.
• The elements affected by external dependency changes are passing.

docs: update README

Description

Update the README file.

Requirements

• Describe what does the app do.
• Update not supported features as not supported yet.
• Mention the use of the lumberdash package for chained-logging, as well as the emoji_lumberdash package for pretty-logging.
• Add OAuth integration instructions for GitHub and maybe another resource server.
• Mention .arb files reference for more complex use cases.
• Add instructions about app config file setup.
• Add a note about the ci-only test tag.

fix: run manual initialization within the app zone

Description

As described in the Flutter error handling docs, manual initialization must be located inside the app zone.

Note that if in your app you call WidgetsFlutterBinding.ensureInitialized() manually to perform some initialization before calling runApp (e.g. Firebase.initializeApp()), you must call WidgetsFlutterBinding.ensureInitialized() inside runZonedGuarded

Requirements

• Run manual initialization within the app zone.

docs: update project README

Description

Improve README to indicate features and usage instructions.

Features

• Add a Features section.

Setup

• Add general instructions for Android app icon setup per flavor
• Add suggested instructions to use App Icon Generator for Android app icon generation considering variants per size.
• Add general instructions for Android splash setup per flavor with light/dark mode.
• Add suggested instructions to use Shape Shifter for vector splash image preview and edition.
• Add detailed instructions for locally setting up Android signing with env variables and config files.

Usage

• Add detailed instructions for debugging and compilation with the terminal considering flavors.

feat: add OAuth example

Description

Implement a demo OAuth flow.

Requirements

• Implement a OAuth flow.

feat: add dev-friendly console logger

Description

Add a development friendly logger.

The print function output is not always that readable and does not support logging levels.
Plus, logging messages are not identifiable nor explicit. Fatal and error messages should be highlighted and should provide the stack trace for easy debugging.

Requirements

• Support easy logging level identification.
• Include stack trace on exceptions logging.
• Enabled for debug mode only.

feat: add caching example

Description

Add a caching flow example.

Requirements

• Use cached data when there is no connectivity.

build: add Flutter/Dart level flavors or envs

Description

Flavors or environments provide a way to develop, test and deploy the app without conflicts with other development stages and with isolated resources and scopes.

The minimum recommended flavors are:

• Development
• Staging
• Production

Requirements

• Implement development, staging and production flavors.
• Use different app name per flavor.
• The build system is passing.
• The elements affected by external dependency changes are passing.

fix: use a secure method to provide secrets

Description

Some secrets have been pushed to the repo as reference of a bad practice.

Steps To Reproduce

1. Go to lib\features\auth\infrastructure\data_sources\authenticator\github.dart.
2. Look for the _clientId and the _clientSecret, which are OAuth related secrets (they have been discarded and revoked, of course).

Expected Behavior

It is expected for this kind of secrets to be provided with a secure method, such as env variables or config files.

ci: ensure up-to-date code generation

Description

Since this project takes advantage of code generation, it could be possible to face problems on CI/CD workflows due to outdated generated code.

Requirements

• Check if generated code is up-to-date.

ci: check 100% coverage

Requirements

• Add 100% coverage check after automated test.
• The ci system is passing.

feat: add adaptive icon for Android

Description

Add adaptive icon for Android.

Requirements

• Add adaptive icon for Android per flavor.
• update docs describing Android adaptive icon.

refactor: reorganize the users feature to keep arch coherence

Description

Locate layers inside the features folder except for the core-regarding ones.

Requirements

• There is no drop in test coverage.

chore: add pull requests template

Description

Create a pull requests template.

Requirements

• Include sub-section to select type of pull request.
• Include sub-section to confirm if there are any breaking changes.

build: configure signing in gradle (Android)

Description

As the Flutter docs and the Android docs state, to publish on the Play Store, you need to give your app a digital signature.

This process can be enabled by default to use env variables or a config file.

Requirements

• Support env variables for keystore reference.
• Support config file for keystore reference.
• Should not check config files to source control.
• Should not check keystore to source control.
• The build system is passing.
• The elements affected by external dependency changes are passing.

ci: add testing workflow for GitHub actions

Description

Add testing workflow for GitHub actions.

Requirements

• Enabled for pull requests and pushes.
• Check zero changes after formatting.
• Analyze code with high severity.
• Run Flutter tests.

feat: add a more complex internationalization example

Description

So far, the .arb files only show basic examples (static string values).

However, at least a couple of examples for plurals and placeholders would be useful.

Requirements

• Add an example for placeholders.
• Add an example for plurals support.

build: add Android flavors

Description

As described in #9, flavors provide a way to develop, test and deploy the app without conflicts with other development stages and with isolated resources, scopes and configuration.

The minimum recommended flavors are:

• Development
• Staging
• Production

Requirements

• Implement development, staging and production flavors.
• Use different app ID per flavor.
• Use different app label per flavor.
• Use different app icon per flavor.
• The build system is passing.
• The elements affected by external dependency changes are passing.

style: use a stricter code analizer

Description

Code analyzers could help to early identify errors and improvements in source code.

Plus, if the analyzer is stricter enough, it might serve as a standardization tool for code styling.

Requirements

• Add linting package. Suggestion: lint package.
• Update code files to resolve linter flags.

chore: add issue templates

Description

Add issue templates to ease issues posting.

Requirements

• Template for issues regarding bugs.
• Template for issues regarding build system or external dependencies.
• Template for issues regarding CI.
• Template for issues regarding code style updates.
• Template for issues regarding documentation.
• Template for issues regarding feature requests.
• Template for issues regarding performance improvements.
• Template for issues regarding refactoring.
• Template for issues regarding reversions.
• Template for issues regarding tests.
• Template for issues that do not affect source or test files.

feat: support internationalization

Description

Support internationalization.

Requirements

• Suppport arb files.
• Add support for English and Spanish (as example).

chore: ignore coverage regarding files

Description

Ignore files related to coverage analysis.

Requirements

• Ignore coverage gen files.
• No functional changes to the code.

feat: add GraphQL integration demo

Description

Create a demo integration with GraphQL.

Requirements

• Create a simple objects list download and display.

feat: add Android splash

Description

Add Android splash screen per flavor.

Requirements

• Use vector icon.
• Support one splash screen per flavor.
• Support splash screens for light and dark mode.

feat: add REST API demo integration

Description

Create a demo integration with a REST API.

Requirements

• Create a simple objects list download and display.