README

This is where your description should go. Try and limit it to a paragraph or two, and maybe throw in a mention of what PSRs you support to avoid any confusion with users and contributors.

Installation

You can install the package via composer:

composer require vns-agency/front-app-merger

Usage

// in you AppServiceProvider
use FrontAppMerger;


public function boot(): void
{
    if ($this->app->runningInConsole())
    {
        FrontAppMerger::registerGitRepo(
            repository: "git@github.com:vns-agency/test.git",
            //the blade file path that should be replaced with the newly generated index.html
            replaceIndexViewPath: resource_path('views/index.blade.php'),// default null

            //optional parameters and its default values

            //the front-end app framework
            projectType: ProjectType::VUE, //currently only supported VUE
            //package manager Yarn or NPM
            packageManagerType: PackageManagerType::Yarn, //defult value
            //disable copying Assets
            copyAssets: true, 
            //set the front-end app build folder 
            distFolderName: 'dist',
            //where should the assets move to 
            copyDistFilesTo: public_path()
        )
        //you can chain as many apps as you want
        ->registerLocalRepo(
            repository: base_path('mayApp'),
            //the blade file path that should be replaced with the newly generated index.html
            replaceIndexViewPath: resource_path('views/index2.blade.php'),// default null
        )
    }
}

This package will run automatically each time you install or update composer. However, you can run it manually using these Artisan commands

//to insatll the fron-end apps 
php artisan frontAppMerger
//to clean up the fron-end apps 
php artisan frontAppMerger:cleanUp

Testing

composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email test@test.com instead of using the issue tracker.

Credits

License

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

vns-agency / front-app-merger

Maintainers

Details