joshbrw / laravel-module-installer
Installs: 167 635
Dependents: 98
Suggesters: 7
Security: 0
Stars: 162
Watchers: 5
Forks: 32
Open Issues: 5
Type:composer-plugin
Requires
- php: 7.* || 8.*
- composer-plugin-api: ^2.0
Requires (Dev)
- composer/composer: ^2.0
- mockery/mockery: ~1.0
- phpunit/phpunit: ~8.0 || ~9.0
README
The purpose of this package is to allow for easy installation of standalone Modules into the Laravel Modules package. This package will ensure that your module is installed into the Modules/
directory instead of vendor/
.
You can specify an alternate directory by including a module-dir
in the extra data in your composer.json file:
"extra": {
"module-dir": "Custom"
}
Installation
- Ensure you have the
type
set tolaravel-module
in your module'scomposer.json
- Ensure your package is named in the convention
<namespace>/<name>-module
, for examplejoshbrw/user-module
would install intoModules/User
- Require this package:
composer require joshbrw/laravel-module-installer
- Require your bespoke module using Composer. You may want to set the constraint to
dev-master
to ensure you always get the latest version.
Notes
- When working on a module that is version controlled within an app that is also version controlled, you have to commit and push from inside the Module directory and then
composer update
within the app itself to ensure that the latest version of your module (dependant upon constraint) is specified in your composer.lock file.