Skip to content

Latest commit

 

History

History
113 lines (66 loc) · 2.58 KB

README.md

File metadata and controls

113 lines (66 loc) · 2.58 KB

👨‍💻 Flutter Boilerplate

Generic badge Generic badge

Flutter Template

⚡️ Getting Started

🚚 How to run, drive, and build Apk

Add .env file to the project directory (see .env.example)

Example how to run development app

flutter clean
flutter pub get
flutter pub run build_runner build --delete-conflicting-outputs
flutter run

Example how to run production app

flutter clean
flutter pub get
flutter pub run build_runner build --delete-conflicting-outputs
flutter build apk -t lib/main_production.dart

⚙️ Supported Flavor

  1. staging
  2. production

🎯 Architecture & Pattern

Reso coder's flutter clean architecture

alt text

⚡️ Module generator

In order to minimize your effort in repetitive code writing, you can use the module_generator.dart

simply run

dart run .\codegen\module_generator.dart

and insert your module name (example: catalog)

🧬️ State Management

Since we use clean architecture, it doesn't matter what state management you prefer to use

But for this project example, we use Bloc

API Documentation

DummyJson

This boilerplate use DummyJson for remote data sources

See Auth to obtain username and password to login in this app

🔠 Naming Convention

snake_case for file and folder.

🔠 Git flow

Commit rules: (feat|fix|docs|style|refactor|perf|test|build|ci):/*

feat: A new feature

fix: A bug fix

docs: Documentation only changes

style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)

refactor: A code change that neither fixes a bug nor adds a feature

perf: A code change that improves performance

test: Adding missing tests

build: Changes to the build/compilation/packaging process or auxiliary tools such as documentation generation

ci: Changes in the continuous integration/delivery setup

examples:

feat(auth): Form Login

feat(product): implement product screen

ci: refactor analysis job

before push

  1. flutter analyze
  2. flutter test

branch rules: (feature|hotfix|coldfix|service|integration|ui)//*

How to contribute

To help work on this project, please refer to CONTRIBUTING.md