Nekoton Repository #

Nekoton repository package

Installation 💻 #

❗ In order to start using Nekoton Repository you must have the Flutter SDK installed on your machine.

Add nekoton_repository to your pubspec.yaml:

dependencies:
  nekoton_repository:

Install it:

flutter packages get

Basic usage 🛠 #

Setup DI:

@InjectableInit(  
  externalPackageModulesBefore: [
    ExternalModule(NekotonRepositoryPackageModule),
  ],
)  
void configureDependencies() => getIt.init();  

Init:

Future<void> configureNekoton() async {
  final nekotonRepository = inject<NekotonRepository>();

  await nekotonRepository.setupNekotonAndStorage(
    storage: inject<NekotonStorageService>(),
  );
}

Continuous Integration 🤖 #

Nekoton Repository comes with a built-in GitHub Actions workflow powered by Very Good Workflows but you can also add your preferred CI/CD solution.

Out of the box, on each pull request and push, the CI formats, lints, and tests the code. This ensures the code remains consistent and behaves correctly as you add functionality or make changes. The project uses Very Good Analysis for a strict set of analysis options used by our team. Code coverage is enforced using the Very Good Workflows.

Running Tests 🧪 #

For first time users, install the very_good_cli:

dart pub global activate very_good_cli

To run all unit tests:

very_good test --coverage

To view the generated coverage report you can use lcov.

# Generate Coverage Report
genhtml coverage/lcov.info -o coverage/

# Open Coverage Report
open coverage/index.html