A template project for new Bitforge Flutter apps.
Main-Goal 👍: Start new and extendable Flutter Apps quickly.
Non-Goal 👎: A jack of all trades or a new Flutter framework.
This project is intentionally kept light both in code size & pubspec dependencies.
I've you wanna share code across projects, consider creating a https://pub.dev library.
Features:
- Quick Setup including app name & identifier, app icon, splashscreen etc.
- Riverpod Architecture inspired by @bizz84
- Modular App Structure aka Feature-First
- Material 3 base theme with dark mode support
- go_router with bottom navigation & deep linking support
- riverpod basic examples for StateNotifier & dependency injection
- dio based REST API example for cute shibe images
- share_plus for sharing doge images
- easy_localization translation ready
- url_launcher to open browser links on all platforms
- app_settings to change app language via system settings
- Clone this repository
git clone https://github.com/bitforge/flutter_template.git appname
- Rename app & identifier
flutter pub global activate rename
rename setAppName -v <YourAppName>
rename setBundleId -v ch.bitforge.<appname>
- Rename dart package name
sed -i '' 's/flutter_template/your_new_name/g' pubspec.yaml
find lib -type f -print0 | xargs -0 sed -i '' 's/flutter_template/your_new_name/g'
- Add your icon an splash image to
assets/images. Then run:
dart run flutter_launcher_icons
dart run flutter_native_splash:create
- Start a new history & initialize your GitHub repo:
rm -rf .git
git init
git commit -am "Initial commit"
git remote add origin [email protected]:<owner>/<repo_name>.git
git push -u origin main
- Start hacking!
For help getting started with Flutter development, view the online documentation, which offers tutorials, samples, guidance on mobile development, and a full API reference.