jack

a starter template for flutter/firebase/riverpod/hooks/gorouter/flavors/theming/icons/launchscreen

How to install

1. mason add jack

2. mason make jack

Firebase Setup

1. in your new app dir
   • if you don't have flutterfire yet run dart pub global activate flutterfire_cli

chmod +x flutterfire_config_flavors.sh

./flutterfire_config_flavors <Firebase-Project-ID> <Firebase-Account-Email (optional)>

only add account email parameter if you need to specify firebase account

*steps 2 and 3 are optional

2. Go to firebase console of project that you created (or existed)

- Setup auth (enable anonymous sign in)

- cloud firestore
- storage
- anything you need.. etc

3) in firebase dir choose same project in previous step

firebase init

Generate Icons and Launch Screens (optional)

1. Change the Icons in the assets directory based off of the examples i have. keep the filenames the same and they have their corresponding flavor.

<your-app-dir>
└───assets
    │   icon.png
    │   icon-dev.png
    │   icon-local.png
    │   foreground.png

2. in rename the .env_config file to .env and edit to your flavor colors

  LOCAL_COLOR='"#FFFFFF"'
  DEV_COLOR='"#000000"'
  PROD_COLOR='"#180437"'

chmod +x icons_and_launch_screen.sh

./icons_and_launch_screen.sh

Theming

For theming this uses the dynamic_color package but when the device isn't supported it uses some themes found in <your-app-dir>/lib/theming/themes.dart

The defaultLightColorScheme and defaultDarkColorScheme can be generated using the Material 3 Theme Builder

Then all you have to do is export to flutter and replace the code in app/lib/theming/themes.dart.

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 jack

# Install globally
mason add -g jack

Usage 🚀

mason make jack

Variables ✨

Hooks 🪝

• ✅   Pre-Gen
• ❌   Post-Gen

Environment 🌎

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

1.0.0

• update all of the dependencies
• change to riverpod generator
• change theming to be better
• easier flutterfire setup for flavors (script)

0.0.7

• fix a bunch of naming issues

0.0.6

• flavor issue

0.0.5

• smooth the auth experience

0.0.4

• fix issues with schemes xcode

0.0.3

• fix locked down to portrait

0.0.2

• clean up

0.0.1

• init

MIT License

Copyright (c) 2023 Jack Slattery

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.