https://github.com/chillerlan/php-library-template
A template/boilerplate for PHP libraries.
https://github.com/chillerlan/php-library-template
php php-library-template php8
Last synced: 7 months ago
JSON representation
A template/boilerplate for PHP libraries.
- Host: GitHub
- URL: https://github.com/chillerlan/php-library-template
- Owner: chillerlan
- License: mit
- Created: 2024-03-08T01:27:56.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-29T22:13:49.000Z (over 1 year ago)
- Last Synced: 2024-04-30T23:10:53.018Z (over 1 year ago)
- Topics: php, php-library-template, php8
- Language: PHP
- Homepage:
- Size: 2.68 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# chillerlan/php-library-template
A template/boilerplate for PHP libraries.
[![PHP Version Support][php-badge]][php]
[![Packagist version][packagist-badge]][packagist]
[![License][license-badge]][license]
[![Continuous Integration][gh-action-badge]][gh-action]
[![CodeCov][coverage-badge]][coverage]
[![Codacy][codacy-badge]][codacy]
[![Packagist downloads][downloads-badge]][downloads]
[php-badge]: https://img.shields.io/packagist/php-v/chillerlan/php-library-template?logo=php&color=8892BF&logoColor=fff
[php]: https://www.php.net/supported-versions.php
[packagist-badge]: https://img.shields.io/packagist/v/chillerlan/php-library-template.svg?logo=packagist&logoColor=fff
[packagist]: https://packagist.org/packages/chillerlan/php-library-template
[license-badge]: https://img.shields.io/github/license/chillerlan/php-library-template
[license]: https://github.com/chillerlan/php-library-template/blob/main/LICENSE
[gh-action-badge]: https://img.shields.io/github/actions/workflow/status/chillerlan/php-library-template/ci.yml?branch=main&logo=github&logoColor=fff
[gh-action]: https://github.com/chillerlan/php-library-template/actions/workflows/ci.yml?query=branch%3Amain
[coverage-badge]: https://img.shields.io/codecov/c/github/chillerlan/php-library-template.svg?logo=codecov&logoColor=fff
[coverage]: https://codecov.io/github/chillerlan/php-library-template
[codacy-badge]: https://img.shields.io/codacy/grade/917022229a8f432e9a15481ebf0c587c?logo=codacy&logoColor=fff
[codacy]: https://app.codacy.com/gh/chillerlan/php-library-template/dashboard
[downloads-badge]: https://img.shields.io/packagist/dt/chillerlan/php-library-template.svg?logo=packagist&logoColor=fff
[downloads]: https://packagist.org/packages/chillerlan/php-library-template/stats
## Overview
### Features
- [GitHub Actions](https://github.com/chillerlan/php-library-template/actions) runner
- [Composer](https://getcomposer.org) dependency management
- [PHPUnit](https://phpunit.de) unit tests
- [PHPStan](https://github.com/phpstan/phpstan) static analysis
- [PHPCS](https://github.com/PHPCSStandards/PHP_CodeSniffer) coding standard analyzer
- [PHPMD](https://phpmd.org) mess detector
- [Codecov](https://codecov.io) code coverage analysis
- [Codacy](https://www.codacy.com) code quality analysis
- [phpDocumentor](https://www.phpdoc.org) auto generated API docs
- [ReadTheDocs](https://readthedocs.org) documentation builder
### Requirements
- PHP 8.1+
## Documentation
- The user manual is at https://php-library-template.readthedocs.io/ ([sources](https://github.com/chillerlan/php-library-template/tree/main/docs))
- An API documentation created with [phpDocumentor](https://www.phpdoc.org/) can be found at https://chillerlan.github.io/php-library-template/
## Disclaimer
Use at your own risk!