HOMSAI App

HOMSAI Flutter application

Used libraries

• flutter_svg: Dart-native SVG rendering library
• intl: used for internationalization and localization facilities such as date/number formatting and parsing
• sqflite: used to persist and query data on the local device
• flutter_localizations: used to support localization
• http: used to consume HTTP resources
• get_it: service locator used to implement dependency injection
• shared_preferences: used to provide a persistent store for simple data
• flutter_native_splash: automatically generates iOS, Android, and Web-native code for customizing this native splash screen background color and splash image.
• formz: unified form representation in Dart. Formz aims to simplify form representation and validation in a generic way.
• rxdart: RxDart extends the capabilities of Dart Streams and StreamControllers.
• bloc: A dart package that helps implement the BLoC pattern.
• flutter_bloc: Widgets that make it easy to integrate blocs and cubits into Flutter. Built to work with package:bloc.
• bloc_concurrency: exposes custom event transformers inspired by ember concurrency. Built to work with bloc.
• equatable: Equatable overrides == and hashCode for you so you don't have to waste your time writing lots of boilerplate code.
• super_rich_text: Handles boilerplate for rich text when you need to make a part of the text with a different font style.
• auto_route: a Flutter navigation package, it allows for strongly-typed arguments passing, effortless deep-linking and it uses code generation to simplify routes setup, with that being said it requires a minimal amount of code to generate everything needed for navigation inside of your App.
• package_info_plus: provides an API for querying information about an application package.
• json_serializable: generates Json Serializable fields reducing boiler plate for from and To Json functions.
• floor: dependency to handle OMR database for sqlfite.
• connectivity_plus: allow Flutter apps to know connectivity status.
• timezone: allow Flutter datetime to handle timezones.
• flutter_launcher_icons: help to generate flutter app icons.
• rive: used to handle .riv animation file.
• flutter_web_auth: used for handling web authentication like google auth.
• network_info_plus: allows Flutter apps to discover network info and configure themselves accordingly.
• fl_chart: chart library that supports Line Chart, Bar Chart, Pie Chart, Scatter Chart, and Radar Chart.
• dropdown_button2: allows dropdown to be more versatile.
• uuid: package to generate unique universal identifier.
• url_launcher: library that allow you to go to web pages
• carousel_slider: Library that allows you to make versatile sliders

Auto Router Generator

Flutter generates route name from app.router.dar automatically.

Use the [watch] flag to watch the files' system for edits and rebuild as necessary.

flutter packages pub run build_runner watch

If you want the generator to run one time and exits use

flutter packages pub run build_runner watch

or

flutter packages pub run build_runner watch --delete-conflicting-outputs

Localization files

Flutter generates localizations files on when building the app.

To generate Flutter localiztion files manually

flutter gen-l10n

Linting

To run Flutter code analysis

flutter analyze

There is no automatic linting automatic fix. You can simply look at linting errors in the Android Studio Dart Analysis section.

Build

To build the release apk

flutter build apk --target {{path of Main.dart}} --release

Pre-commit hook integration

This will perform the lint on every commit and will abort it in case of errors

In the root of the project run

cp pre-commit-hook .git/hooks/pre-commit

Then give permission with command

chmod +x .git/hooks/pre-commit

Pre-commit hook fails in Fork

If your commit fails due to flutter command not being found, your flutter sdk is not in your $PATH.

Follow flutter documentation to update your path.

Then add the following line to pre-commit-hook file and change [FLUTTER_SDK_LOCATION] to be the path of your clone of the Flutter git repo, for example $HOME/flutter

export PATH=[FLUTTER_SDK_LOCATION]/bin:$PATH

Then in the root of the project run

cp pre-commit-hook .git/hooks/pre-commit

Finally give permission with command

chmod +x .git/hooks/pre-commit