danidoble / laravel-package-skeleton
A simple Laravel package skeleton development environment
Requires
- php: ^8.1
Requires (Dev)
- laravel/pint: ^1.14
- laravel/prompts: ^0.1.21
- orchestra/testbench: ^8.21|^v9.0.0
- pestphp/pest: ^2.34
README
Create your own laravel package with this skeleton.
requirements
For Laravel 10
- PHP 8.1
For Laravel 11 and above
- PHP 8.2 or higher
Installation
composer create-project danidoble/laravel-package-skeleton --prefer-dist
Note for Windows
Windows not support laravel prompts, so you need to create project, and when it finishes, you need to run the following commands:
Enter to the project folder
cd laravel-package-skeleton
Experimental Expose assets (js, css)
If you want to expose route assets (js, css) in your package, you need to select yes in web routes, and the next question
Do you want to expose assets with url? (This will expose 2 routes (by default), E.g. /assets/css and /assets/js.)
If you want to expose assets with url, select yes again.
Notes
- This feature is experimental, and may not work as expected.
- This feature only support tailwindcss, but you can add your own css framework.
Execute the configuration script
php configure.php
update composer
composer update
or in one line
cd laravel-package-skeleton && php configure.php && composer update
Usage
If you want test the basic route run:
./vendor/bin/testbench serve
then open your browser and go to http://127.0.0.1:8000/
routes
If you added web routes in your package, you can test it by going to
http://127.0.0.1:8000/package-route
.
Note: package-route is the route pre-defined in the package,
when you configure the package this route change to your-name-package-route
Ex. my package is Testing so my route will be testing-route
, so you need to open http://127.0.0.1:8000/testing-route
instead of previous route.
to check the complete list of commands run:
./vendor/bin/testbench list
for more information about testing with orchestra/testbench visit Orchestra Testbench