⚡ Basic Setup

A brick to create the basic structure for the API Integration and Beta setup foran application. This brick will create a massive structure on your directory and genrates some ready to use code.

All you have to do is to call the mehtods in controllers and do business logic stuff.

💫 Features

This brick will create following modules for you:

• Constants
  • api constants file
  • assets constants file
• Environment
  • env model file
  • all envrionments file
• Model
  • Repository model file
  • API response model file
• Repository
  • Sample auth repository file
• Services
  • api service
    • sample auth service file
  • Dio service
    • api interceptor
    • dio builder
  • exception handler
  • snackbar manager
  • api token manager
• Utils
  • image utils
  • general utils
• widgets base widget (with predefined ThemeData)

How to use 🚀

mason make basic_setup

Variables ✨

Outputs 📦

constants
├── api_constants.dart
├── assets_constants.dart

env
├── env.dart
├── envs.dart

models
├── repository_response_model.dart
├── response_model.dart

repositories
├── auth_repository.dart

services
├── api_service
    ├── auth_service.dart
├── dio_service
    ├── api_interceptor.dart
    ├── dio_builder.dart
├── exception_handler.dart
├── snackbar_manager.dart
├── token_manager.dart

utils
├── image_utils.dart
├── utils.dart

widgets
├── base_widget.dart

Dependencies

This setup is dependent on the following packages. You always add or remove as per your requirements. To avoid any error in code copy the following dependencies and add it in your pubspec.yaml file.

  cached_network_image: ^3.3.0
  carousel_slider: ^4.2.1
  cupertino_icons: ^1.0.2
  dio: ^5.3.3
  dio_cache_interceptor: ^3.4.4
  dropdown_button2: ^1.7.2
  flutter:
    sdk: flutter
  flutter_facebook_auth: ^6.0.2
  flutter_staggered_animations: ^1.1.1
  get: 4.6.5
  google_fonts: ^6.1.0
  google_sign_in: ^6.1.5
  image_cropper: ^5.0.0
  image_picker: ^1.0.4
  intl: ^0.18.1
  intl_phone_number_input: ^0.7.3+1
  package_info_plus: ^4.2.0
  pin_code_fields: ^8.0.1
  pull_to_refresh: ^2.0.0
  shared_preferences: ^2.2.2
  shimmer: ^3.0.0
  sign_in_with_apple: ^5.0.0
  sizer: ^2.0.15
  video_player: ^2.7.2

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 basic_setup

# Install globally
mason add -g basic_setup

Usage 🚀

mason make basic_setup

Variables ✨

Hooks 🪝

• ❌   Pre-Gen
• ❌   Post-Gen

Environment 🌎

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

3.0.2+9

• Email field added in user model

3.0.2+8

• Relative path errors resolved.
• Readme updated.

3.0.1+7

• Relative path errors resolved.

3.0.0+6

• Api parsers added
• Theme Directory Changed
• Bottom-sheet service added
• Dialog service added
• Dio Builder updated
• Snackbar manager updated
• Token manager updated
  • Compatibility added for Access Tokens
  • Compatibility added for JWT Tokens
  • Clear token method added
• User manager updated
  • Basic Implementation added
• Utils updated
• Image Utils updated
  • getImageFromPhone compatibility added
  • Convertors added
• Custom Tabbar Widget added
• Image View Widget added
• Selectable Dropdown widget added
• Dropdown Widget added

2.0.0+5

• TODO: Describe initial release.

The MIT License (MIT) Copyright (c) 2022 Muhammad Talha

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.