An open API service indexing awesome lists of open source software.

https://github.com/andrewdyer/php-package-template

A template for creating PHP 8.3+ packages
https://github.com/andrewdyer/php-package-template

php-template template

Last synced: 7 months ago
JSON representation

A template for creating PHP 8.3+ packages

Awesome Lists containing this project

README

          

![PHP Package Template](https://raw.githubusercontent.com/andrewdyer/public-assets/refs/heads/main/images/covers/php-package-template.png)

# PHP Package Template

A template for creating PHP 8.3+ packages.

## βš–οΈ License

Licensed under the [MIT license](https://opensource.org/licenses/MIT) and is free for private or commercial projects.

## ✨ Introduction

This template provides a solid foundation for building modern PHP packages. It’s designed to help you hit the ground running and focus on building your package functionality without worrying about boilerplate setup like autoloading, testing, or Composer configuration.

## πŸ“‹ Prerequisites

Before you begin, ensure you have met the following requirements:

- **PHP**: Version 8.3 or higher.
- **[Composer](https://getcomposer.org)**: A dependency manager for PHP, used to install packages and autoload your code.

## πŸ› οΈ Features

This template includes the following tools and configurations:

- [PSR-4 autoloading](https://www.php-fig.org/psr/psr-4/) via Composer
- [PHPUnit](https://phpunit.de/) for unit testing to ensure the reliability of your code.
- [PHP Coding Standards Fixer](https://cs.symfony.com/) for maintaining consistent code style.
- CI (Continuous Integration) setup with [GitHub Actions](https://github.com/features/actions) for automated testing.

## πŸš€ Getting Started

If you like what you've seen so far and think this setup fits your needs, you can quickly get started by clicking the **Use this template** button at the top of the repository on GitHub.

## 🀝 Contributing

Found a bug or want to improve this package? Feel free to open a pull request or submit an issue.