rapid_app_starter

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 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 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 package as a dependency to give the developer means for structured logging.

How to install

Install 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

Output

The following files are created and/or modified. Please note, that some of the installed packages, such as the flutter_native_splash package 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.

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).

Setup 🧑‍💻

Ensure you have the mason_cli installed.

# 🎯 Activate from https://pub.dev
dart pub global activate mason_cli

# 🍺 Or install from https://brew.sh
brew tap felangel/mason
brew install mason

Installation ☁️

# Install locally
mason add rapid_app_starter

# Install globally
mason add -g rapid_app_starter

Usage 🚀

mason make rapid_app_starter

Variables ✨

Hooks 🪝

• ✅   Pre-Gen
• ✅   Post-Gen

Environment 🌎

mason: ">=0.1.0-dev.51 <0.1.0"

0.2.1

• Minor fix in the README.md file.

0.2.0

• flutter_native_splash package is added to improve user experience by preventing and customizing the white splash screen displayed by the native app that loads Flutter.
• Rapid App Starter splash image is added to the assets directory.
• Rapid App Starter launcher icons are added to this mason brick.
• New boolean variable called generate_icons is added to this brick to allow the developer decide if Rapid App Starter launcher icons are needed in the newly generated app or not.
• Documentation in the README.md file is modifed accordingly.
• Minor fix to improve performance.
• MaterialApp title fixed.

0.1.3

• flutter_localization package is upgraded to 0.2.0 and package_info_plus is upgraded to 5.0.1.

0.1.2

• Description in brick.yaml is shortened to less than 120 characters.

0.1.1

• Badges for the license and for the platform are added.
• Links of screenshots are replaced with URLs to github.
• Unnecessary comments are removed from screen_main.dart.

0.1.0

• Initial release supports android.
• Shows splashscreen at startup.
• Reads and writes shared preferences to load and save state.
• Shows license at startup, then forces accepting the license, otherwise the app exits.
• Supports Material 3.
• Supports a navigation drawer, where language, color scheme, theme can be selected, license and about can be displayed.
• Business logic for supporting four languages: English, German, Hungarian and Spanish.
• Supports predefined color schemes, which can be easily customized.
• Brightness of the app can be easily changed.

BSD 3-Clause License

Copyright (c) 2023, Zoltán Katona, PhD

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.