Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ka-zo/rapid_app_starter
Empower your Flutter app with seamless language, theme, brightness customization, and license handling.
https://github.com/ka-zo/rapid_app_starter
android app dart flutter mason
Last synced: 8 days ago
JSON representation
Empower your Flutter app with seamless language, theme, brightness customization, and license handling.
- Host: GitHub
- URL: https://github.com/ka-zo/rapid_app_starter
- Owner: ka-zo
- License: bsd-3-clause
- Created: 2023-11-13T18:57:10.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-01-31T23:36:09.000Z (10 months ago)
- Last Synced: 2024-04-25T04:34:48.818Z (7 months ago)
- Topics: android, app, dart, flutter, mason
- Language: Dart
- Homepage:
- Size: 7.36 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# rapid_app_starter
[](https://opensource.org/license/bsd-3-clause)
[](https://www.android.com/)
[](https://github.com/felangel/mason)
Accelerate app development effortlessly! This Flutter package offers a powerful starting template
featuring Material 3 support, seamless internationalization, easy license handling, and flexible
themes. With built-in state management and a navigation drawer for enhanced user experience,
kickstart your project and watch your app come to life with ease and finesse.
## Why this package?
Streamline your app development process effortlessly. Most apps require users to customize language,
color schemes, brightness, and agree to a license — repetitive development tasks you, as a developer,
shouldn't have to redo. This Flutter package simplifies this by providing a pre-built foundation.
Save time and effort, focus on what makes your app unique, while essential customization and
compliance features are seamlessly integrated and ready to use. Get ahead, efficiently.
## Features
- Splash screen: A splash screen is added to allow the initialization of the app and loading the state from
shared preferences.
- License handling: You can add your own license to the [License] class in
multiple languages. Currently, English, German, Hungarian and Spanish are supported. This license
shall be displayed after the splash screen, the first time the app starts up. The user has to accept
this license, otherwise the app exits.
- Shared preferences: The app supports state management using the
[shared_preferences](https://pub.dev/packages/shared_preferences) package
- Navigation drawer: The app has a built in navigation drawer defined in the [MyNavigationDrawer]
widget. The user can access that can be injected into any new page you create.
- languages:
- Color schemes: The app supports [Material 3](https://m3.material.io/) design with corresponding
widgets and color schemes. The [ColorSchemeDefinition] class contains predefined color schemes.
The user can change the actual color scheme by navigating to the corresponding menu provided by the
[MyNavigationDrawer] class.
- Brightness: The user can set the brightness of the app to light, dark or system by navigating to
the corresponding menu provided by the [MyNavigationDrawer] class.
- View license: The user can view the accepted license by selecting the corresponding menu in the
navigation drawer widget of the app defined in the [MyNavigationDrawer] class.
- About:
- Logging: the app uses the [logger](https://pub.dev/packages/logger) package as a dependency to
give the developer means for structured logging.
## How to install
Install [Mason CLI](https://pub.dev/packages/mason_cli) it's must have for using Mason bricks.
```
dart pub global activate mason_cli
```
Create your new Flutter project:
```
flutter create {project_name}
```
move to project folder:
```
cd {project_name}
```
Initialize mason:
```
mason init
```
Add mason brick to your project:
```
mason add rapid_app_starter
```
Start generating Infinum architecture folder structure:
```
mason make rapid_app_starter
```
## Variables
| Variable | Description | Default | Type |
| ----------------- | ------------------------------------------------------------------------------------------------------------- | ----------------------------------------- | --------- |
| `verbose` | If installation of this brick should be verbose | false | `boolean` |
| `app_name` | Full name of the app, that should be displayed on the app. This is not the same as the one in pubspec.yaml. | Rapid App Starter | `string` |
| `generate_icons` | If rapid app starter launcher icons should be added to the flutter app | false | `boolean` |
| `copyright_notice`| Copyright notice to be displayed in the app. | Copyright (c) 2023 Your Company Name, Inc.| `string` |
| `license` | This license shall be displayed by the app, and shall be saved in the LICENSE file of the project. | BSD-3-Clause | `enum` |
## Output
The following files are created and/or modified. Please note, that some of the installed packages,
such as the [flutter_native_splash package](https://pub.dev/packages/flutter_native_splash) may generate
additional files compared to what this brick generates.
```
📂 {project_name}
┣ 📂 android
┃ ┣ 📂 app
┃ ┃ ┣ 📂 src src and its content is added, modifed only if generate_icons is True
┃ ┃ ┃ ┗ 📂 main
┃ ┃ ┃ ┗ 📂 res
┃ ┃ ┃ ┣ 📂 mipmap-anydpi-v26
┃ ┃ ┃ ┃ ┣ 📄 ic_launcher_round.xml
┃ ┃ ┃ ┃ ┗ 📄 ic_launcher.xml
┃ ┃ ┃ ┣ 📂 mipmap-hdpi
┃ ┃ ┃ ┃ ┣ 📄 ic_launcher_foreground.png
┃ ┃ ┃ ┃ ┣ 📄 ic_launcher_round.png
┃ ┃ ┃ ┃ ┗ 📄 ic_launcher.png
┃ ┃ ┃ ┣ 📂 mipmap-ldpi
┃ ┃ ┃ ┃ ┗ 📄 ic_launcher.png
┃ ┃ ┃ ┣ 📂 mipmap-mdpi
┃ ┃ ┃ ┃ ┣ 📄 ic_launcher_foreground.png
┃ ┃ ┃ ┃ ┣ 📄 ic_launcher_round.png
┃ ┃ ┃ ┃ ┗ 📄 ic_launcher.png
┃ ┃ ┃ ┣ 📂 mipmap-xhdpi
┃ ┃ ┃ ┃ ┣ 📄 ic_launcher_foreground.png
┃ ┃ ┃ ┃ ┣ 📄 ic_launcher_round.png
┃ ┃ ┃ ┃ ┗ 📄 ic_launcher.png
┃ ┃ ┃ ┣ 📂 mipmap-xxhdpi
┃ ┃ ┃ ┃ ┣ 📄 ic_launcher_foreground.png
┃ ┃ ┃ ┃ ┣ 📄 ic_launcher_round.png
┃ ┃ ┃ ┃ ┗ 📄 ic_launcher.png
┃ ┃ ┃ ┣ 📂 mipmap-xxxhdpi
┃ ┃ ┃ ┃ ┣ 📄 ic_launcher_foreground.png
┃ ┃ ┃ ┃ ┣ 📄 ic_launcher_round.png
┃ ┃ ┃ ┃ ┗ 📄 ic_launcher.png
┃ ┃ ┃ ┗ 📂 values
┃ ┃ ┃ ┗ 📄 ic_launcher_background.xml
┃ ┃ ┗ 📄 build.gradle
┃ ┗ 📄 local.properties
┣ 📂 assets
┃ ┣ 📄 logo_no_background.png
┣ 📂 lib
┃ ┣ 📄 eula.dart
┃ ┣ 📄 globals.dart
┃ ┣ 📄 languages.dart
┃ ┣ 📄 main.dart
┃ ┣ 📄 preferences.dart
┃ ┣ 📄 screen_eula.dart
┃ ┣ 📄 screen_main.dart
┃ ┣ 📄 theme_data.dart
┃ ┗ 📄 widget_navigationdrawer.dart
┣ 📄 flutter_native_splash.yaml
┣ 📄 pubspec.yaml
┗ 📄 LICENSE
```
## Add your own splashscreen image
Add your splash image in the assets directory. Make sure that you modify the `flutter_native_splash.yaml` file
according to the documentation available on the homepage of the [flutter_native_splash package](https://pub.dev/packages/flutter_native_splash).
After modifying the `flutter_native_splash.yaml` file, do not forget to run the following command in the terminal in the root directory of your generated flutter app:
```
dart run flutter_native_splash:create
```
## Add your own custom license
You can change the license, that shall be displayed by the app, anytime, by
opening the `eula.dart` file, and then modifying the content of the License class.
Requesting the custom license as mason input during installation is not practical, as
the size of the license is most likely too big for that.
## Add new words to the existing dictionaries
Open the `languages.dart` file. First, you need to add a key to the `AppLocale` class as static const String, then you need to use this new key in the static Maps defined for each language in the same class to add the corresponding translations. From that point on, you can reference your new word using the key you defined as static const String previously (in the following example I use "newkey" as the new key), like `AppLocale.newkey.getString(context)`.