Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/spatie/package-skeleton-laravel
A skeleton repository for Spatie's Laravel Packages
https://github.com/spatie/package-skeleton-laravel
bootstrap package php
Last synced: 3 days ago
JSON representation
A skeleton repository for Spatie's Laravel Packages
- Host: GitHub
- URL: https://github.com/spatie/package-skeleton-laravel
- Owner: spatie
- License: mit
- Created: 2015-06-04T18:42:55.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2024-09-20T13:29:58.000Z (3 months ago)
- Last Synced: 2024-10-29T15:26:30.308Z (about 2 months ago)
- Topics: bootstrap, package, php
- Language: PHP
- Homepage: https://laravelpackage.training
- Size: 455 KB
- Stars: 2,054
- Watchers: 35
- Forks: 608
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# :package_description
[](https://packagist.org/packages/:vendor_slug/:package_slug)
[](https://github.com/:vendor_slug/:package_slug/actions?query=workflow%3Arun-tests+branch%3Amain)
[](https://github.com/:vendor_slug/:package_slug/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
[](https://packagist.org/packages/:vendor_slug/:package_slug)
---
This repo can be used to scaffold a Laravel package. Follow these steps to get started:
1. Press the "Use this template" button at the top of this repo to create a new repo with the contents of this skeleton.
2. Run "php ./configure.php" to run a script that will replace all placeholders throughout all the files.
3. Have fun creating your package.
4. If you need help creating a package, consider picking up our Laravel Package Training video course.
---
This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
## Support us
[
](https://spatie.be/github-ad-click/:package_name)
We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
## Installation
You can install the package via composer:
```bash
composer require :vendor_slug/:package_slug
```
You can publish and run the migrations with:
```bash
php artisan vendor:publish --tag=":package_slug-migrations"
php artisan migrate
```
You can publish the config file with:
```bash
php artisan vendor:publish --tag=":package_slug-config"
```
This is the contents of the published config file:
```php
return [
];
```
Optionally, you can publish the views using
```bash
php artisan vendor:publish --tag=":package_slug-views"
```
## Usage
```php
$variable = new VendorName\Skeleton();
echo $variable->echoPhrase('Hello, VendorName!');
```
## Testing
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [:author_name](https://github.com/:author_username)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.