Starter Template

A Flutter starter app that includes support for an HTTP client, themes, routing, localization, and dependency injection.

Brick Uses:

• dio as an HTTP client
• pretty_dio_logger as a dio interceptor
• auto_route for routing
• get_it for dependency injection
• envied for secure handling of environment variables
• very_good_analysis for lint rules

Project Structure

• "app" folder holds files specific to this particular application.
• "core" folder contains application-agnostic code that can be reused in other projects.
• "feature" folder represents the app's feature set.

How to use 🚀

Make sure you have the mason_cli installed.

dart pub global activate mason_cli

Add starter_template to your library

mason add starter_template

Generate your brick

mason make starter_template

Warning ⚠️

Ensure the environment/ folder is included in your .gitignore to protect sensitive configuration

Variables ✨

Output 📦

📦lib
 ┣ 📂app
 ┃ ┣ 📂constants
 ┃ ┃ ┗ 📜string_constants.dart
 ┃ ┣ 📂environment
 ┃ ┃ ┣ 📜app_environment.dart
 ┃ ┃ ┣ 📜development_environment.dart
 ┃ ┃ ┣ 📜development_environment.g.dart
 ┃ ┃ ┣ 📜production_environment.dart
 ┃ ┃ ┗ 📜production_environment.g.dart
 ┃ ┣ 📂l10n
 ┃ ┃ ┣ 📂arb
 ┃ ┃ ┃ ┣ 📜app_en.arb
 ┃ ┃ ┃ ┗ 📜app_tr.arb
 ┃ ┃ ┗ 📜l10n.dart
 ┃ ┣ 📂router
 ┃ ┃ ┣ 📜app_router.dart
 ┃ ┃ ┗ 📜app_router.gr.dart
 ┃ ┣ 📂theme
 ┃ ┃ ┣ 📂base
 ┃ ┃ ┃ ┗ 📜base_theme.dart
 ┃ ┃ ┣ 📂dark
 ┃ ┃ ┃ ┗ 📜dark_theme.dart
 ┃ ┃ ┗ 📂light
 ┃ ┃ ┃ ┗ 📜light_theme.dart
 ┃ ┗ 📂view
 ┃ ┃ ┗ 📜app.dart
 ┣ 📂core
 ┃ ┣ 📂clients
 ┃ ┃ ┗ 📂network
 ┃ ┃ ┃ ┗ 📜network_client.dart
 ┃ ┣ 📂extensions
 ┃ ┃ ┗ 📜context_extensions.dart
 ┃ ┗ 📂utils
 ┃ ┃ ┣ 📂device_info
 ┃ ┃ ┃ ┗ 📜device_info_utils.dart
 ┃ ┃ ┗ 📂package_info
 ┃ ┃ ┃ ┗ 📜package_info_utils.dart
 ┣ 📂feature
 ┃ ┗ 📂home
 ┃ ┃ ┣ 📂model
 ┃ ┃ ┃ ┗ 📜.gitkeep
 ┃ ┃ ┣ 📂view
 ┃ ┃ ┃ ┗ 📜home_view.dart
 ┃ ┃ ┗ 📂view_model
 ┃ ┃ ┃ ┗ 📜.gitkeep
 ┣ 📜bootstrap.dart
 ┣ 📜locator.dart
 ┣ 📜main_development.dart
 ┗ 📜main_production.dart

Contributing

Contributions are always welcomed and appreciated!

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 starter_template

# Install globally
mason add -g starter_template

Usage 🚀

mason make starter_template

Variables ✨

Hooks 🪝

• ✅   Pre-Gen
• ✅   Post-Gen

Environment 🌎

mason: "^0.1.0-dev.52"

1.1.6

• Removed /environment folder from .gitignore to resolve build_runner issues.

1.1.5

• Refactored post gen hook

1.1.4

• Added output section to README.md

1.1.3

• Added multi-environment setup using envied
• Removed injectable because it reduced the flexibility of the environment setup.

1.1.2

• Added package info utils
• Added device info utils

1.1.1

• Upgraded dependencies to the latest versions

1.1.0

• Upgraded dependencies to the latest versions
• Used Dart 3.0 class modifiers

1.0.9

• Added base theme for easier theme customization
• Upgraded dependencies to the latest versions
• Migrated to Dart 3.0

1.0.8

• Refactored project structure for improved organization and readability
• Switched to Flutter's default localization package (flutter_localizations) for simplified internationalization and localization
• Added code generation with Injectable for improved dependency injection and reduced boilerplate code

1.0.7

• Service locator added. get_it
• Dependency versions bumped to latest versions.

1.0.6

• Minor change made to improve readability in hook files.

1.0.5

• Refactored hooks as suggested #514

1.0.4

• AutoRoute version bumped to 5.0.1

1.0.3

• Improved post and pre gen hooks for easier installation.
• Update README.md

MIT License

Copyright (c) 2022 Cem Avcı

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.