ridrog / boilerplate
Boilerplate for Laravel Packages
Installs: 10
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Type:package
Requires
- php: ^7.2
- illuminate/support: ^6.0
Requires (Dev)
- orchestra/testbench: ^4.0
- phpunit/phpunit: ^8.0
This package is auto-updated.
Last update: 2024-10-20 22:46:30 UTC
README
How to use this laravel package boilerplate
Setup
Step 1
Clone or download this Repository into a laravel installtion.
Step 2
- Rename all Files from "BoilplateXxxxx.php" to "YourPackageNameXxxxx.php"
- Search and Replace "Boilerplate" with "YourPackageName" (case sensitive!)
- Search and Replace "boilerplate" with "yourpackagename" (case sensitive!)
- Replace the name in the LICENSE File
Step 3
- Use your terminal to cd to the root of this package
- Run
composer install
- Run the tests
composer test
Step 4
- Add the namespace and the path to the composer.json File of your laravel installation
"autoload": {
"classmap": [
"database/seeds",
"database/factories"
],
"psr-4": {
"App\\": "app/",
"{Vendor}\\{{PackageName}}\\": "packages/{vendor}/{packagename}/src/
}
},
- Add the Service Provider to config/app.php
Development
-
Update all the readme /docs files
Delete what you don't need
You also need to delete links from \docs\index.md to the not used/deleted files in \docs\details -
Develop the package
Publish
- Create a Github repository for your package
- Push the package to github
- Bonus: Enable Github Pages in the settings of the repository
- Generate a Release
- Add the package to packagist
- Bonus: Add the github repository to travis to run test on every change that is pushed to the repository
- Delete this section
- DONE
What is this
Installation
Usage
Config
Details
Facade
Routes
Controllers
Views
Middleware
Migrations
Seeder
Commands
Translation
Events and Listeners
Notifications
Tests
Change log
Please see CHANGELOG for more information what has changed recently.
Testing
$ composer test
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email mail@ridrog.de instead of using the issue tracker.
Credits
License
The MIT License (MIT). Please see License File for more information.