Flutter Boilerplate #

This repository provides a boilerplate source code to streamline the initial setup of new Flutter projects. Developed by moshafDEV, it ensures consistency, scalability, and adherence to best practices through Clean Architecture principles.

Features #

• Clean Architecture structure for maintainability and scalability
• Modular codebase for rapid development
• Pre-configured assets and essential directories
• Ready-to-use templates for common features
• Integrated support for multiple environments using flutter_flavor
• State management with flutter_bloc
• Dependency injection via get_it
• Networking powered by dio
• Local storage setup with flutter_secure_storage
• Routing handled by go_router
• Linting and code quality enforced with flutter_lints
• Unit and widget testing configuration
• Customizable theme and localization support
• Error handling and logging modules
• Analytics integration for screen tracking
• Example implementation for authentication (login/profile)
• Separation of data, domain, and presentation layers
• Configurable environment variables and DI modules

Installation Guide #

Follow these steps to install moshaf_boilerplate globally using Dart Pub:

1. Install Dart SDK
   Ensure Dart SDK is installed on your system.
   Refer to the official guide: dart.dev/get-dart.

2. Open Terminal or Command Prompt
   Use your preferred terminal (Linux/Mac) or Command Prompt (Windows).

3. Run Installation Command
   Execute the following command to install moshaf_boilerplate globally:

   dart pub global activate moshaf_boilerplate
   

4. Verify Installation
   Confirm the installation by running:

   moshaf_boilerplate --help
   

   If help information is displayed, the installation was successful.

5. Add Dart Pub Global Path (if required)
   If the command is not recognized, add Dart's global pub path to your environment variables:

   • Linux/Mac: $HOME/.pub-cache/bin
   • Windows: %USERPROFILE%\.pub-cache\bin

   Example for Linux/Mac:

   export PATH="$PATH:$HOME/.pub-cache/bin"
   

Usage Guide #

Once installation is complete, follow these steps to initialize your Flutter project using moshaf_boilerplate:

1. Open CLI in Your Project Directory
   Navigate to the folder where you want to create your new Flutter project.

2. Run the Boilerplate Creation Command
   Execute the following command:

   moshaf_boilerplate create
   

   This will scaffold your project with the recommended structure and templates.

Note:
After generating your project, it is highly recommended to review and customize your .gitignore file to ensure that unnecessary files and directories are excluded from version control. This helps maintain a clean repository and prevents accidental commits of sensitive or build-related files.

⚙️ Setup Android and iOS Project #

After generating the project using this boilerplate, complete the following additional steps to ensure the application runs properly on both Android and iOS.

flavorDimensions("flavor")
productFlavors {
    create("dev") {
        dimension = "flavor"
        namespace = "com.example.example"
        applicationId = "com.example.example"
    }
    // create("prod") {
    //     dimension = "flavor"
    //     namespace = "com.moshaf.example"
    //     applicationId = "com.moshaf.example"
    // }
}

android/app/src/dev
android/app/src/prod

FLAVOR

Packaging > Info.plist File

ios/config/dev/Info.plist
ios/config/prod/Info.plist

Build Settings > Packaging > Product Bundle Identifier

Build Phases > Copy Bundle Resources

Directory Structure Overview #

Note: The following diagram illustrates the recommended folder structure, demonstrating clear separation of concerns in accordance with Clean Architecture.

├── assets
│   ├── animations
│   ├── fonts
│   ├── icons
│   ├── images
│   ├── svg
│   └── translations
├── build.yaml
├── config.json
├── lib
│   ├── app.dart
│   ├── core
│   │   ├── analytics
│   │   │   └── screen_analytics
│   │   ├── config
│   │   │   ├── di_module
│   │   │   └── loggers
│   │   ├── constants
│   │   ├── env
│   │   ├── error
│   │   ├── http_client
│   │   │   ├── interceptors
│   │   ├── routes
│   │   ├── services
│   │   └── utils
│   ├── data
│   │   ├── datasources
│   │   │   ├── local
│   │   │   └── remote
│   │   ├── models
│   │   │   ├── login
│   │   │   │   ├── request
│   │   │   │   └── response
│   │   │   └── profile
│   │   │       └── response
│   │   └── repository_impls
│   ├── domain
│   │   ├── entities
│   │   │   ├── auth
│   │   │   ├── login_param
│   │   │   ├── profile
│   │   │   └── text_input_field
│   │   ├── repositories
│   │   └── usecase
│   │       └── login
│   └── presentation
│       ├── bloc
│       │   └── login
│       ├── component
│       └── pages
│           ├── home
│           │   ├── components
│           ├── login
│           │   ├── components
│           ├── splash_screen
│           │   ├── components
│           └── welcome
│               ├── components

Recommended Versions #

For best compatibility and performance, use the following versions:

• Flutter: < 3.41.0 Check your version:

  flutter --version
  

• Dart: < 3.11.0
  Check your version:

  dart --version
  

Refer to the official Dart installation guide: https://dart.dev/get-dart.

After installation, ensure the Dart SDK path is added to your system's environment variables.
Example for macOS/Linux:

export PATH="$PATH:/usr/local/bin/dart"

On Windows, add the Dart SDK path (e.g., C:\tools\dart-sdk\bin) to your system's PATH variable.

References #

• Dart Pub Documentation
• moshaf_boilerplate Package

Authors #

• @moshaf