README

based on project nwidart/laravel-modules

Introduction

The Goodcatch Laravel Modules library overwrite "nwidart/laravel-modules" service provider.

It extends "nwidart/laravel-modules" library, provide database activator.

Because of Laravel Package Discovery, "nwidart/laravel-modules" has been listed in composer.json.

Installation

There might be a little bit more complicated things to do.

* add required php composer library
* do minor changes to laravel application
* initialize application
* add first goodcatch laravel-module 'Core'
* getting started development

install library

composer require goodcatch/laravel-modules

modify Application

find file /path_to_project/bootstrap/app.php

change Kernel from app kernel to goodcatch kernel

for example

// ...

$app->singleton(
    Illuminate\Contracts\Console\Kernel::class,
    Goodcatch\Modules\Laravel\Console\Kernel::class
);


// ...

for mcamara/laravel-localization

make sure Laravel Localization default local is 'en' if no Laravel Localization supported locals
in project configuration file 'project/config/laravellocalization.php' presents.

// ...

return [

    /*
    |--------------------------------------------------------------------------
    | Application Locale Configuration
    |--------------------------------------------------------------------------
    |
    | The application locale determines the default locale that will be used
    | by the translation service provider. You are free to set this value
    | to any of the locales which will be supported by the application.
    |
    */

    'locale' => 'en',
];

// ...

make sure laravel-localization is configured to laravel http kernel

// ...
class Kernel extends HttpKernel
{

// ...


    /**
     * The application's route middleware.
     *
     * These middleware may be assigned to groups or used individually.
     *
     * @var array
     */
    protected $routeMiddleware = [

        // ...

        // localization

        'localize'                => \Mcamara\LaravelLocalization\Middleware\LaravelLocalizationRoutes::class,
        'localizationRedirect'    => \Mcamara\LaravelLocalization\Middleware\LaravelLocalizationRedirectFilter::class,
        'localeSessionRedirect'   => \Mcamara\LaravelLocalization\Middleware\LocaleSessionRedirect::class,
        'localeCookieRedirect'    => \Mcamara\LaravelLocalization\Middleware\LocaleCookieRedirect::class,
        'localeViewPath'          => \Goodcatch\Modules\Laravel\Http\Middleware\LocalizationViewPath::class

        // ...

    ];

// ...

}

Autoloading

By default the module classes are not loaded automatically. You can autoload your modules using psr-4 if modules are placed in different folder. For example:

{
  "autoload": {
    "psr-4": {
      "App\\": "app/",
      "Goodcatch\\Modules\\": "storage/app/modules"
    }
  }
}

Note: don't forget to make sure the folder 'storage/app/modules' exists or checkout environment configuration name 'MODULE_INSTALL_PATH'.

Tip: don't forget to run composer dump-autoload afterwards.

module admin pages

Goodcatch Modules providers admin page to show modules list and disable/enable module if you want it.

first of all, generate tables and then install them.

php artisan goodcatch:table

php artisan migrate

php artisan goodcatch:cache

open modules admin page: http://domain/goodcatch/laravel-modules/modules

install the first module Core

composer require goodcatch/laravel-module-core

php artisan module:migrate core --seed

checkout modules admin page, there will be a module named 'Core'.

Getting stated with development

have not created any module yet, create it at first

Create first new module, the name is 'core'

php artisan module:make core

Environments

# optional that pre-append module route path in url
# default to: m
MODULE_ROUTE_PREFIX=m

# optional that change the default modules path from app/Modules to new path
# default to: storage/app/modules
MODULE_INSTALL_PATH=storage/app/modules

# optional that update module
# default to: https://laravel-modules.goodcatch.cn/dl?p=%s&n=%s&v=%s&s=%s
MODULE_INSTALL_REPO_URL=https://laravel-modules.goodcatch.cn/dl?p=%s&n=%s&v=%s&s=%s

# optional that indicate base project that laravel-modules is going to work with
MODULE_INTEGRATE=

Licensed under The MIT License (MIT).

goodcatch / laravel-modules

Maintainers

Details