$ sh -c "$(curl -fsSL https://raw.githubusercontent.com/naveteam/flutter-boilerplate/main/setup.sh)"
- Install all dependencies
$ flutter pub get
- Create .env file at the root with key:value pairs corresponding to
.env.example
It's a required step since we use code-generation tool to generate helper classes for environment variables.
- Run code-generation tool
$ flutter pub run build_runner build
- Start coding 😄
-
You can check if there's an update available for all dependencies running
flutter pub outdated
. You also can update withflutter pub upgrade
orflutter pub upgrade --major-versions
. Check if it doesn't have any huge breakchange before upgrading with--major-versions
argument. -
It's possible to modify the application dart package name. You only have to edit the
name
property atpubspec.yaml
, replace all imports withpackage:flutter_boilerplate
topackage:[your-package-name]
and download all dependencies withflutter pub get
again. You must follow the dart guidelines for the package name or it will fail. -
If you want to use a State Management Library alternative to
ChangeNotifier + Provider
, runflutter pub remove provider
, install what you need withflutter pub add [package_name]
and refactor all view models to match with the library of your choice.
TBD