Flutter Template Generator

A command-line tool to quickly generate Flutter projects from B-L Studios template with interactive setup.

Features

  • 🚀 Interactive CLI setup
  • 📱 Pre-configured for dev and prod flavors
  • 🔥 Firebase ready structure
  • 🎨 Flavorizr integration for app icons
  • 💻 IDE configuration (VS Code & Android Studio)
  • 🧹 Automatic project cleanup and setup
  • ✨ Colored terminal output for better UX

Prerequisites

  • Flutter SDK (3.35.1 or higher)
  • Dart SDK (3.9.0 or higher)
  • Git

Installation

Install globally using pub:

dart pub global activate ca_generator

Make sure ~/.pub-cache/bin is in your PATH.

Usage

Run the generator:

ca_generator

The tool will guide you through:

  1. Project Location - Where to create your project
  2. Project Name - Must be lowercase with underscores
  3. Package Name - Android package name (com.company.app format)
  4. IDE Choice - VS Code or Android Studio
  5. Confirmation - Review settings before creation

Command Line Options

ca_generator --help      # Show help
ca_generator --version   # Show version

What Gets Created

Your new Flutter project includes:

  • ✅ Two flavors: dev and prod
  • ✅ Firebase configuration structure
  • ✅ Custom app icons setup
  • ✅ Makefile with common commands
  • ✅ Pre-configured project structure
  • ✅ IDE-specific configurations

Next Steps After Creation

  1. Navigate to your project:

    cd /path/to/your/project

  2. Set up Firebase (optional):

    • Generate Firebase configuration files
    • Place them in the .firebase folder

  3. Add custom app icons:

    • Add your logo files to assets/images
    • Run make flavorizr to apply icons

  4. Explore available commands:

    make help

Available Make Commands

  • make clean - Clean the project
  • make pub-get - Get dependencies
  • make flavorizr - Configure app icons and flavors
  • make run-dev - Run development flavor
  • make run-prod - Run production flavor
  • make build-dev - Build development APK
  • make build-prod - Build production APK

Template Repository

This tool uses the template from: https://github.com/B-L-Studios/flutter-temp

Troubleshooting

Command not found

If ca_generator command is not found after installation:

  1. Make sure pub cache bin is in your PATH:

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

  2. Or run directly:

    dart pub global run ca_generator

Prerequisites not met

Make sure you have Flutter and Git installed:

flutter doctor    # Check Flutter installation
git --version     # Check Git installation

Contributing

  1. Fork the repository
  2. Create your feature branch
  3. Commit your changes
  4. Push to the branch
  5. Create a Pull Request

License

MIT License - see LICENSE file for details.

Support

Made with ❤️ by B-L Studios

Libraries