Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ouedyan/flutter-mobile-app-template
Flutter Mobile App Project Template
https://github.com/ouedyan/flutter-mobile-app-template
autoroute easy-localization flutter flutter-architecture flutter-configuration flutter-examples flutter-launcher-icons flutter-native-splash flutter-secure-storage flutter-template flutter-templates template-project
Last synced: 2 months ago
JSON representation
Flutter Mobile App Project Template
- Host: GitHub
- URL: https://github.com/ouedyan/flutter-mobile-app-template
- Owner: ouedyan
- Created: 2022-06-16T06:50:31.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-11-21T13:56:23.000Z (almost 2 years ago)
- Last Synced: 2024-07-08T20:03:28.301Z (3 months ago)
- Topics: autoroute, easy-localization, flutter, flutter-architecture, flutter-configuration, flutter-examples, flutter-launcher-icons, flutter-native-splash, flutter-secure-storage, flutter-template, flutter-templates, template-project
- Language: Dart
- Homepage:
- Size: 66.4 KB
- Stars: 21
- Watchers: 2
- Forks: 13
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Flutter Mobile App Project Template (flutter_bloc, autoroute, dio, json_serializable, easy_localization bot_toast, flutter_secure_storage(and helpers), flutter_screenutil, flutter_native_splash, flutter_launcher_icons and other generally used features and tools in production.)
This is a battery included [Flutter](https://flutter.dev/) project template. To the default setup have been added:
- [flutter_bloc](https://bloclibrary.dev/) - Predictable and Highly testable state management library for Dart.
- [autoroute](https://pub.dev/packages/autoroute) - Robust and customizable Flutter navigation package.
- [dio](https://pub.dev/packages/dio) - Popular and powerful Http client for Dart.
- [json_serializable](https://pub.dev/packages/json_serializable) - Generates to/from json serialization code for our data models.
- [easy_localization](https://pub.dev/packages/easy_localization) - Easy and Fast internationalization.
- [bot_toast](https://pub.dev/packages/bot_toast) - Feature-Rich Toast/alert/notification/popup library for Flutter.
- [flutter_secure_storage](https://pub.dev/packages/flutter_secure_storage) - A Flutter plugin to store data in secure storage (encrypted, not in plain text like shared_preferences). Eg. for storing user credentials, tokens...
- [flutter_screenutil](https://pub.dev/packages/flutter_screenutil) - A package for adapting screen and font size.
- [flutter_svg](https://pub.dev/packages/flutter_svg) - For rendering SVG assets.
- Some tooling for project initial setup.
- [flutter_native_splash](https://pub.dev/packages/flutter_native_splash) - Generates iOS, Android, and Web-native code for customizing the native splash screen background color and splash image.
- [flutter_launcher_icons](https://pub.dev/packages/flutter_launcher_icons) - Fully flexible toolset for updating your Flutter app's launcher icons (Android and Ios).
- [rename](https://pub.dev/packages/rename) - Change your flutter project's AppName and BundleId (IOS, Android, macOS and Web).
- [change_app_package_name](https://pub.dev/packages/change_app_package_name) - Complementary to **rename** package, for changing app package name in Android and renaming correctly directories (which **rename** doesn't do).
## Project Config roadmap (Just Informative. Don't repeat these steps.)
All the necessary config and dependencies have already been set and ready for use but there is an explanation of each step if you want to know more about the pre-config or customize it.
Initialize the Flutter project, add all the necessary dependencies mentioned above in the **pubspec.yaml** configuration file and run `pub get`.
**pubspec.yaml**
```yaml
dependencies:
flutter:
sdk: flutter
# ...
# ...
# Http client
dio: ^4.0.6
# I18n
intl: ^0.17.0
easy_localization: ^3.0.1
# Secure String key-value storage
flutter_secure_storage: ^5.0.2
# Dependency Injection
provider: ^6.0.3
# State management
flutter_bloc: ^8.0.1
equatable: ^2.0.3
bloc: ^8.0.3
# Navigation
auto_route: ^4.0.1
# Global in-app alert/notification/toast/snackBar
bot_toast: ^4.0.2
# Responsiveness
flutter_screenutil: ^5.5.3+2
#SVG Support
flutter_svg: ^1.1.0
# Data Model Json serialization annotations
json_annotation: ^4.5.0
#Native Splash screen autoconfiguration
flutter_native_splash: ^2.2.3+1
dev_dependencies:
flutter_test:
sdk: flutter
# ...
# ...
# Code generation
build_runner: ^2.1.11
auto_route_generator: ^4.0.0
# Json serialization code generation
json_serializable: ^6.2.0
# Native Launcher Icons generator
flutter_launcher_icons: ^0.9.3
# Change app package name/bundle id and app name
change_app_package_name: ^1.1.0
rename: ^2.0.1
```
Change the app name to your own one.
```bash
flutter pub run rename --appname "YourAppName"
```
Change the package name/bundle id to your own one.
```bash
flutter pub run change_app_package_name:main com.company.name &&
flutter pub run rename --bundleId com.company.name
```
Add **flutter_native_splash.yaml** config file to the project root directory.
_(See the concerned for more information)_
```yaml
flutter_native_splash:
# ...
color: "#ffffff"
background_image: "assets/background.png"
image: assets/splash.png
# ...
```
Generate the splash screens after you have added your own configuration.
```bash
flutter pub run flutter_native_splash:create
```
Add **flutter_launchers_icons.yaml** config file to the project root directory.
_(See the concerned for more information)_
```yaml
flutter_icons:
android: "launcher_icon"
ios: true
image_path: "assets/icons/launcher_icon.png"
# Icons with alpha channel are not allowed in the Apple App Store.
remove_alpha_ios: true
# ...
```
Generate the launcher icons after you have added your own configuration.
```bash
flutter pub run flutter_launcher_icons:main
```
The android minSdKVersion is set to **Android API level 21** to comply to modern libraries requirements support. Eg. flutter_secure_storage (requires Android API level 18).
**android/app/build.gradle**
```groovy
android {
//...
defaultConfig {
//...
minSdkVersion 21
targetSdkVersion flutter.targetSdkVersion
versionCode flutterVersionCode.toInteger()
versionName flutterVersionName
}
//...
}
```
## Scripts
Change package name/bundle id
```bash
flutter pub run change_app_package_name:main com.new.package.name && flutter pub run rename --bundleId com.new.package.name
```
Change App Name
```bash
flutter pub run rename --appname "NewAppName"
```
Run build_runner to generate/regenerate code from code generating packages (autoroute, easy_localization, json_serializable, etc.)
```bash
flutter pub run build_runner build
```
Generate while overriding old outputs
```bash
flutter packages pub run build_runner build --delete-conflicting-outputs
```
Watch and regenerate after each change
```bash
flutter pub run build_runner watch
```
Generate easy_localization translation string keys for usage in code
```bash
flutter pub run easy_localization:generate -O lib/core/ -f keys -o locale_keys.g.dart --source-dir assets/translations
```
Generate native launcher icons from config.
```bash
flutter pub run flutter_launcher_icons:main
```
Generate native splash screens from config
```bash
flutter pub run flutter_native_splash:create
```
## Project directory structure
Main folders structure
```
📂 assets
📂 icons
📂 images
📂 translations
📄 en.json
...📄 {locale}.json
📂 lib
📂 bloc
...📂 bloc
📄 {global_bloc}.dart
📄 {global_bloc_event}.dart
📄 {global_bloc_state}.dart
📂 core
📂 bloc
📄 app_bloc_observer.dart
📂 local_storage
📄 local_storage_manager.dart
📂 network
📄 dio_manager.dart
📂 theme
📄 colors.dart
📄 constants.dart
📄 dependency_injection.dart
📄 navigation.dart
📄 utils.dart
📂 ui
📂 widgets
...📄 {common_widget}.dart
📂 screens
...📂 {screen}.dart
📂 view_bloc
📄 {screen_bloc}.dart
📄 {screen_bloc_event}.dart
📄 {screen_bloc_state}.dart
📄 main.dart
📂 test
📄 flutter_launcher_icons.yaml
📄 flutter_native_splash.yaml
📄 pubspec.yaml
```
## Project tech stack useful resources
### Flutter
- [Flutter](https://flutter.dev) - Flutter framework official website.
- [Flutter Docs](https://docs.flutter.dev) - Flutter official documentation.
### Dart
- [Dart](https://dart.dev) - Dart language official website.
- [Dart Docs](https://dart.dev/guides) - Dart official documentation.