Dio Cubit Starter

A brick to generate a clean architecture based starter structure utilizing dio for network calls along with dependency injection and cubit state management.

📌 Essential Information

This brick will generate a pubspec.yaml file, a .env file and a lib folder with all its contents - you don't have to manually add any packages. Optionally, the brick will allow you to setup auto_route if you wish to use that package for navigation.

Note: This brick will store your secrets (in this case the API base url) within a .env file and generate a subsequent env.g.dart file. Do not check these files onto your version control.

🚀 Usage

In the root of your project, run the following:

mason make dio_cubit_starter --on-conflict overwrite

This command fetches the required pub packages and begins generating the freezed files after the brick has been made.

🧑‍💻 Variables

💼 Output

|-- lib
    |-- core
        |-- injection
            |-- env.dart
            |-- env.g.dart
            |-- injection.dart
            |-- module.dart
        |-- util
            |-- constants.dart
            |-- failures.dart
        |-- router #if <use_auto_route> is true
            |-- routes.dart
            |-- routes.gr.dart
    |-- features
        |-- <name>
            |-- cubit
                |-- <name>_cubit.dart
                |-- <name>_cubit.freezed.dart
                |-- <name>_state.dart
            |-- presentation
                |-- pages
                    |-- <name>_page.dart
                |-- widgets
                    |-- <name>_widget.dart
            |-- repository
                |-- <name>_repository.dart
                |-- i_<name>_repository.dart
    |-- main.dart
|-- pubspec.yaml
|-- .env

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 dio_cubit_starter

# Install globally
mason add -g dio_cubit_starter

Usage 🚀

mason make dio_cubit_starter

Variables ✨

Hooks 🪝

• ❌   Pre-Gen
• ✅   Post-Gen

Environment 🌎

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

0.1.2

• refactor: moved api url to .env file

0.1.1

• chore: README typo fix

0.1.0

• feat: initial release with support for Cubit generation
• Added dio for api calls, logger for debug logs and freezed for code generation
• Option to use auto_route for screen navigation, default set to false

MIT License

Copyright (c) 2024 Ayush Rajguru

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.