🚀 Aurora Monzim

Aurora is a simple Flutter project architecture that leverages Riverpod, go_router, and Isar for state management, navigation, and data persistence, making it easy to use and maintain.

• Aurora Documentation
• Aurora GitHub
• Aurora Brick Code

What is Aurora? 🤨

Aurora is a Flutter project architecture that is easy to use and maintain. This architecture follows a combination of principles from various design patterns and architectural styles such as provider pattern, model view preenter, modular architecture, and widget composition. It is heavily dependent on Code Generation.

Why Aurora? 🤔

I used to follow others architecture and I found that they are not easy to use and maintain. So I decided to create my own architecture that is easy to use and maintain. I have been using this architecture for my personal projects and I am happy with it. I hope you will like it too.

Aurora is created by monzim 🧱*.

Aurora tree

lib/
├── main.dart
├── services
│   ├── app_preference
│   │   ├── constants
│   │   │   └── app_default_setting.dart
│   │   ├── models
│   │   │   ├── app_preference.dart
│   │   │   └── app_preference.g.dart
│   │   └── providers
│   │       ├── app_settings_provider.dart
│   │       └── app_settings_provider.g.dart
│   ├── local_storage
│   │   └── isar
│   │       ├── constants
│   │       │   └── isar_constants.dart
│   │       ├── helper
│   │       │   └── isar_base.dart
│   │       └── providers
│   │           ├── isar_provider.dart
│   │           └── isar_provider.g.dart
│   ├── localization
│   │   ├── arb
│   │   │   ├── app_bn.arb
│   │   │   └── app_en.arb
│   │   ├── extention
│   │   │   └── locale_extention.dart
│   │   └── providers
│   │       ├── localization_provider.dart
│   │       └── localization_provider.g.dart
│   ├── riverpod
│   │   ├── extention
│   │   │   └── riverpod_extention.dart
│   │   ├── helper
│   │   │   └── provider_helper.dart
│   │   └── riverpod.dart
│   ├── routers
│   │   ├── app_router.dart
│   │   ├── app_router.g.dart
│   │   ├── router_provider.dart
│   │   └── router_provider.g.dart
│   └── themes
│       ├── constants
│       │   └── app_fonts.dart
│       ├── extention
│       │   └── color_extention.dart
│       ├── helpers
│       │   ├── dark_mode
│       │   │   ├── dark_mode_helper.dart
│       │   │   └── dark_mode_helper.g.dart
│       │   └── light_mode
│       │       ├── light_mode_helper.dart
│       │       └── light_mode_helper.g.dart
│       └── providers
│           ├── color_scheme_seed_provider.dart
│           ├── color_scheme_seed_provider.g.dart
│           ├── font_family_provider.dart
│           ├── font_family_provider.g.dart
│           ├── theme_mode_provider.dart
│           ├── theme_mode_provider.g.dart
│           ├── themes_provider.dart
│           └── themes_provider.g.dart
└── src
    ├── global
    │   ├── extention
    │   │   └── extention.dart
    │   ├── global.dart
    │   ├── helper
    │   ├── package
    │   │   └── packages.dart
    │   └── widgets
    ├── pages
    │   ├── error
    │   │   ├── error_page.dart
    │   │   └── widgets
    │   │       └── error_widget.dart
    │   ├── home
    │   │   ├── home_page.dart
    │   │   ├── providers
    │   │   │   ├── home_provider.dart
    │   │   │   └── home_provider.g.dart
    │   │   ├── sections
    │   │   │   └── documentation_section.dart
    │   │   └── widgets
    │   │       └── my_image_w.dart
    │   ├── settings
    │   │   ├── providers
    │   │   │   ├── settings_provider.dart
    │   │   │   └── settings_provider.g.dart
    │   │   ├── sections
    │   │   │   ├── app_color_section.dart
    │   │   │   ├── font_section.dart
    │   │   │   └── language_section.dart
    │   │   ├── settings_page.dart
    │   │   └── widgets
    │   │       └── theme_toggle_widget.dart
    │   └── splash
    │       └── splash_scree.dart
    └── services
        ├── README.md
        └── service_name
            ├── constants
            ├── models
            ├── providers
            └── typedefs

50 directories, 55 files

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 aurora

# Install globally
mason add -g aurora

Usage 🚀

mason make aurora

Variables ✨

Hooks 🪝

• ✅   Pre-Gen
• ✅   Post-Gen

Environment 🌎

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

0.0.1+2

• Isar Database Update

0.0.1+1

• Initial release.

Copyright (c) 2023 Azraf Al Monzim

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.