generator-ftb

FTB Generator - A boilerplate code generator for Flutter BLoC Architecture

THIS PROJECT HAS BEEN DISCOUNTINUATED. I RECOMMEND YOU USE SLIDY.

A simple, but powerful boilerplate code generator for flutter projects using bloc pattern. There are some libs out there for organization purposes like modular, but on my case I didn't want make use of a lib that impose restrictions on the code level, because as the project grows, some restrictions have the potential to become a problem. The main objective of this project it's just speed up flutter development generating boilerplate code with a specific code organization structure. The code organization structure used on this generator was based on previous work of flutter community, but I encourage you to fork this project and make changes on the template folders to addapt to your specific needs or send pull requests if your changes could improve the code organization for the majority of flutter developers.

Inspiration

• Sebastian Faust work: https://github.com/devonfw-forge/devonfw4flutter-mts-app
• Conner Aldrich work: https://medium.com/flutter-community/flutter-code-organization-revised-b09ad5cef7f6
• Modular team work: https://github.com/Flutterando/modular#modular-structure

Flutter Libraries Used

Dependencies on pubscpec.yaml:

dependencies:
  flutter:
    sdk: flutter
  equatable: ^1.2.2
  bloc: ^6.0.1
  flutter_bloc: ^6.0.1
  easy_localization: ^2.3.2
  easy_localization_loader: ^0.0.2

It's also important put the translation files directory on your pubspec:

flutter:
  assets:
    - assets/translations/

Installation

First, install Yeoman and generator-ftb using npm (we assume you have pre-installed node.js).

npm install -g yo
npm install -g generator-ftb

Project Structure

On ./flutter_project_example you can find a flutter project example using the directory structure used on this generator. The project directory structure is combination of a component approach, a layered approach and tree like approach.

Getting To Know Yeoman

• Yeoman has a heart of gold.
• Yeoman is a person with feelings and opinions, but is very easy to work with.
• Yeoman can be too opinionated at times but is easily convinced not to be.
• Feel free to learn more about Yeoman.

License

MIT