Giter Club home page Giter Club logo

flutter_bloc_kit's Introduction

Flutter Kit

This kit is a boilerplate for Flutter projects. It comes with a set of preconfigured features and utilities to help you get started with your project.

Get started

1. Clone the repository

git clone https://github.com/afesohromeo/flutter_bloc_kit.git

2. Customize the project

Install the Rename CLI Tool by executing the following command:

flutter pub global activate rename

Run the following commands:

_rename setAppName --targets ios,android --value "YourAppName"
  • This will set the AppName for the iOS and Android platforms to "YourAppName".
rename setBundleId --targets ios,android --value "com.example.bundleId"
  • This will set the BundleId for the Android and Ios platform to "com.example.bundleId".

If you are building for other platforms other than android and ios make sure to specify in "--targets" parameter. For more info on Rename Cli tool checkout [https://pub.dev/packages/rename]

Features

This kit comes with a set of preconfigured features and utilities:

  • I18n
  • Navigation (using go_router)
  • State management (using BLoc)
  • Extensions (on context, iterable)
  • Utility widgets
  • Default Theming using Material 3 and google font

πŸ—ΊοΈ I18n

This kit uses packages flutter_localizations and intl for internationalization. To add a new language, add a new file to the src/core/l10n folder. The file name should be the language code prefixed with app_ (e.g. intl_fr.arb).

To generate the code for the new language, run the following command:

flutter pub get

Alternatively, you can install the flutter_intl package in VSCode to automatically generate the code when you save the file.

πŸ›£οΈ Navigation

This kit uses go_router for navigation. To add a new route, add a new route to the file src/core/routing/route_manager.dart.

See the go_router documentation for more information.

🧱 State Management

This kit uses BLoC for state management. See the BLoC documentation for more information.

An example of a BLoC can be found in the src/features/home_screen/logic folder.

πŸ—Ό Extensions

This kit comes with a few extensions on the BuildContext and Iterable classes. See the src/shared/extensions folder for more information.

πŸ“Œ Utils

Widgets

This kit comes with a few utility widgets. See the src/shared/components folder for more information.

Assets

Assets paths are automaticalle generated when using build_runnner thanks to the flutter_gen package.

πŸ–ŒοΈ Theming

This kit uses the new Material 3 theming system. See the src/core/theme folder for more information.

The default color scheme is generated using https://m3.material.io/theme-builder#/custom. You can use this tool to generate your own color scheme.

πŸ’Ό Need a new feature?

If you need a new feature, please open an issue on the GitHub repository

πŸ“‡ Get in touch

If you have any questions, feel free to contact me on Twitter

flutter_bloc_kit's People

Contributors

afesohromeo avatar stevenosse avatar stevsct avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.