encrypted_storage

Description:

encrypted storage

Encrypted Storage #



This package provides a fast and simple way to store and retrieve encrypted data usind sqflite. It uses AES encryption via encrypt to encrypt the data and flutter_secure_storage to store key and initialization vector.
Installation 💻 #
❗ In order to start using Encrypted Storage you must have the Flutter SDK installed on your machine.
Add encrypted_storage to your pubspec.yaml:
dependencies:
encrypted_storage:
copied to clipboard
Basic usage 🛠 #
Setup DI:
@InjectableInit(
externalPackageModulesBefore: [
ExternalModule(EncryptedStoragePackageModule),
],
)
void configureDependencies() => getIt.init();
copied to clipboard
Init:
Future<void> configureEncryptedStorage() async {
final encryptedStorage = inject<EncryptedStorage>();
await encryptedStorage.init();
}
copied to clipboard
Melos magic 🪄 #
Using melos makes it very easy to work with the project, so enjoy.
You can run any job interactively run running melos run and selecting needed case or directly (e.g. melos run test).
Bootstrap 🏁 #
Melos takes care about dependencies of all packages, including managing of local-generated library version. So, just run:
melos bs
copied to clipboard
Codegen 🦾 #
This thing will run all code generators for all packages:
$ melos run codegen
copied to clipboard
Clean up 🧹 #
Just run commands below to clean all, including build directories and flutter projects.
melos clean
copied to clipboard
Tests ✔️ #
You can run all tests at one by running this command.
melos run test
copied to clipboard
Code 📊 #
You can run code analysis:
melos run analyze
copied to clipboard
Code format 🗃️ #
melos run check-format will check, melos run format will fix dart code formatting.
melos run check-format
melos run format
copied to clipboard
Prepare to commit 🤝🏻 #
melos run check-all will ckeck, analyze and run all tests.
melos run check-all
copied to clipboard
Conventional Commits ❤️ #
This magic will update version and build our library automatically using commit messages and tags. Conventional Commits is a lightweight convention on top of commit messages.
Version 🏷️ #
Package version control is done by melos. It runs by gh action 'Create version PR' melos version -a --yes.
Github Secrets 🔑 #
BOT_ACCESS_TOKEN: Personal access token (PAT) used to fetch the repository. We should use PAT and not default GITHUB_TOKEN because "When you use the repository's GITHUB_TOKEN to perform tasks, events triggered by the GITHUB_TOKEN, with the exception of workflow_dispatch and repository_dispatch, will not create a new workflow run". We want to trigger a workflow from the workflow (to run tests), so we need to use PAT. This thing is used in version workflow.