https://github.com/spatie/package-skeleton-php

A skeleton repository for Spatie's PHP Packages
https://github.com/spatie/package-skeleton-php

package php skeleton template

Last synced: about 2 months ago
JSON representation

A skeleton repository for Spatie's PHP Packages

• Host: GitHub
• URL: https://github.com/spatie/package-skeleton-php
• Owner: spatie
• License: mit
• Created: 2020-05-10T08:56:37.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-07-08T18:15:17.000Z (2 months ago)
• Last Synced: 2024-07-11T20:31:47.280Z (2 months ago)
• Topics: package, php, skeleton, template
• Language: PHP
• Homepage: https://laravelpackage.training
• Size: 200 KB
• Stars: 484
• Watchers: 14
• Forks: 131
• 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

[![Latest Version on Packagist](https://img.shields.io/packagist/v/:vendor_slug/:package_slug.svg?style=flat-square)](https://packagist.org/packages/:vendor_slug/:package_slug)

[![Tests](https://img.shields.io/github/actions/workflow/status/:vendor_slug/:package_slug/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/:vendor_slug/:package_slug/actions/workflows/run-tests.yml)

[![Total Downloads](https://img.shields.io/packagist/dt/:vendor_slug/:package_slug.svg?style=flat-square)](https://packagist.org/packages/:vendor_slug/:package_slug)

---

This package can be used as to scaffold a framework agnostic 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.

4. If you need help creating a package, consider picking up our Laravel Package Training video course.

---

This is where your description should go. Try and 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

```

## Usage

```php

$skeleton = new VendorName\Skeleton();

echo $skeleton->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](https://github.com/spatie/.github/blob/main/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.