README

Filament Modular Luncher is the ultimate module management solution for Laravel Modular applications. Seamlessly integrate module management into your Filament admin panel, allowing you to install, update, backup, and restore modules with a single click.

✨ Features

• 📦 Seamless Integration: Native Filament resource for managing modules.
• 🔍 Module Discovery: Automatically scans and lists all installed modules.
• 🩺 Module Health & Diagnostics: Run Module Doctor, status, debug, and explain actions directly from Filament.
• 🧬 Dependency Intelligence: Inspect requires, conflicts, and provides from Laravel Modular 1.2 manifests.
• ⬇️ Multi-Source Installation: Install modules from:
  • 📂 Local ZIP Uploads
  • 🔗 Direct URLs (ZIP)
  • 🐙 Git Repositories (Private & Public)
  • 🐘 Composer Packages
• 🛡️ Hardened Operations: Safer ZIP extraction, Composer/Git process execution, URL allowlists, vendor allowlists, and secret redaction.
• 🔄 Updates: Update modules via Git pull or easy re-installation.
• 💾 Backups: Create and restore backups of your modules instantly.
• 🗑️ Uninstallation: Safe removal of modules and their assets.
• 🤖 Laravel Boost Ready: Ships AI guidance for safe, native Laravel Modular workflows.
• 🛠️ Modern Laravel Ready: Built for PHP 8.3+ with Laravel 12 and 13 readiness.

🌍 Ecosystem

Enhance your modular application with our official packages:

• Laravel Modular: Review the core package documentation.
• Laravel Hooks: Specific modular hook system support.
• Filament Integration: Seamless Filament admin panel integration in modules.
• Livewire Integration: First-class Livewire component support in modules.
• Laravel Themer: Advanced theme management system.

🚀 Installation

Install the package via Composer:

composer require alizharb/filament-modular-luncher

Register the plugin in your Filament Panel Provider:

use AlizHarb\ModularLuncher\ModularLuncherPlugin;

public function panel(Panel $panel): Panel
{
    return $panel
        // ...
        ->plugin(ModularLuncherPlugin::make());
}

That's it! You will now see a Modules resource in your admin panel.

🔧 Configuration

Publish the configuration file for customization:

php artisan vendor:publish --tag="modular-luncher-config"

Configuration Options

• installation.git_binary: Path to your git binary.
• updates.github_token: Token for accessing private repositories.
• backups.disk: Storage disk for backups (default: local).

📖 Usage

Installing a Module

1. Navigate to the Modules resource in your admin panel.
2. Click Install Module.
3. Choose your source (ZIP, URL, or Composer).
4. Fill in the required details and click Install.

Managing Modules

• Update: Click the update action on any module table row.
• Backup: Select a module and click "Backup" to create a ZIP snapshot.
• Restore: Restore a module from a previous backup.
• Uninstall: Remove a module from your system.

💖 Sponsors

We would like to extend our thanks to the following sponsors for funding Laravel Modular development. If you are interested in becoming a sponsor, please visit the Laravel Modular GitHub Sponsors page.

🌟 Acknowledgments

• Laravel: For creating the most elegant PHP framework.
• Filament: For the amazing admin panel builder.
• Spatie: For setting the standard on Laravel package development.

🤝 Contributing

We welcome contributions! Please see CONTRIBUTING for details.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

🔒 Security

If you discover any security-related issues, please email Ali Harb at harbzali@gmail.com.

📄 License

The MIT License (MIT). Please see License File for more information.

Made with ❤️ by Ali Harb