https://github.com/studio24/laravel-package-template

A repository template for Studio 24's open source Laravel packages
https://github.com/studio24/laravel-package-template

Last synced: 21 days ago
JSON representation

A repository template for Studio 24's open source Laravel packages

• Host: GitHub
• URL: https://github.com/studio24/laravel-package-template
• Owner: studio24
• License: mit
• Created: 2025-11-23T11:33:14.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2025-12-10T16:07:50.000Z (6 months ago)
• Last Synced: 2026-05-14T10:52:54.127Z (about 1 month ago)
• Language: PHP
• Size: 23.4 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

          
# PHP Package Template

A repository template for Studio 24's open source Laravel packages.

## How to use this template

This package can be used as to scaffold a PHP package. Follow these steps to get started:

1. Press the "Use 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.

## Components

A brief explanation of the different components of this package template.

- `.github/ISSUE_TEMPLATE` - GitHub issue templates

- `.github/workflows` - GitHub actions for running tests (php.yml) and automated releases (release.yml)

- `.github/dependabot.yml` - Dependabot configuration

- `config` - Config file for your Laravel package

- `database` - Laravel database files (factories and migrations)

- `resources` - Laravel resources (templates)

- `src/` - The PHP source code for your Laravel package, this will autoload based on the autoload rules in composer.json

- `src/Commands` - Laravel artisan command

- `src/Facades` - Laravel facades

- `src/ExampleClass.php` - An example class

- `src/PackageTemplateServiceProvider.php` - Service Provider for your Laravel package

- `tests` - PHPUnit tests for your package

- `.editorconfig` - Your [editor coding style](https://editorconfig.org/) configuration

- `.gitattributes` - Ignore these files/folders when this package is installed via Composer

- `.phpcs.xml.dist` - [PHPCodeSniffer](https://github.com/PHPCSStandards/PHP_CodeSniffer/) configuration

- `.phplint.yml` - [PHPLint](https://github.com/overtrue/phplint) configuration

- `CHANGELOG.md` - A list of notable changes, the contents of this file are automated by automated releases

- `CODE_OF_CONDUCT.md` - Contributor's code of conduct

- `composer.json` - Composer PHP package dependencies

- `configure.php` - Package configuration script, this file is deleted after configure.php is run

- `CONTRIBUTING.md` - Guide to contributing

- `LICENSE.md` - License information

- `phpstan.neon` - [PHPStan](https://phpstan.org/) configuration

- `phpunit.xml.dist` - [PHPUnit](https://phpunit.de/) configuration

- `README.md` - This README file, this file is deleted once configure.php is run

- `README_DEFAULT.md` - The default README file for your new package, this file is copied to README.md after configure.php is run

- `SECURITY.md` - Security policy for this package

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

## Thanks to

* [Spatie Laravel Package Skeleton](https://github.com/spatie/package-skeleton-laravel)