jhj0517/flutter_mvvm_bloc_template

Flutter MVVM temlpate with BLOC pattern as a starting point

Flutter MVVM (Bloc) Template

Simple template for MVVM with in Flutter with flutter_bloc. This template is integrated with Mason.

Architecture

Overview

• Notices
  1. Put important variables like API keys in the .env file.
  2. Basic retrofit & sqflite usage implemented in home_page.dart.
  3. Localization implemented with Flutter Intl Plugin.
• Core Versions

dependencies:
  cupertino_icons: ^1.0.6
  path: ^1.9.0

  # BLOC Pattern
  bloc: ^8.1.2
  flutter_bloc: ^8.0.1
  equatable: ^2.0.5

  # Local DB
  sqflite: ^2.3.3
  shared_preferences: ^2.2.3
  flutter_dotenv: ^5.1.0

  # Dependency Injection
  get_it: ^7.7.0

  # Network
  retrofit: ^4.1.0
  json_annotation: ^4.8.1
  dio: ^5.4.3+1

  # Localization
  intl: ^0.19.0    

dev_dependencies:
  # Network
  retrofit_generator: '>=7.0.0 <8.0.0'
  build_runner: '>=2.3.0 <4.0.0'
  json_serializable: ^6.6.2

flutter:
  assets:
    - assets/images/
    - .env

Folder structure

Layer-first structure

lib/
├── constants/                                 (static constant values)
├── di/                                        (dependency injectors)
├── generated/                                 (generated l10n classes)
├── l10n/                                      (localization tables)
├── data
│   ├── data_source
│   │   ├── localdb/                           (SQLite components)
│   │   └── network/                           (Retrofit components)
│   ├── models/                                (data classes)
│   └── repositories/                          (repositories)
└── presentation
    ├── providers/                             (providers)
    └── views/                                 (pages including widget classes)
assets/
└── images/                                    (image asset files)
.env                                           (important variables such as API Key)

How to Make & Use Template

1. Install Mason CLI ( If it's not installed )

   dart pub global activate mason_cli
   

2. Git clone this repository

   git clone https://github.com/jhj0517/flutter_mvvm_bloc_template.git
   

3. Add the brick as the global (you can change the brick name in brick.yaml as you want. )

   mason add -g flutter_mvvm_bloc --path ./
   

4. Check that the brick is added correctly.

   mason ls -g
   ├── flutter_mvvm_bloc 0.1.0  // it prints something like this
   

5. You can now start a new project with your own template

   mason make flutter_mvvm_bloc