chillerlan / php-library-template
A PHP Library template/boilerplate.
Fund package maintenance!
Ko-Fi
1.0.0
2024-03-09 02:26 UTC
Requires
- php: ^8.1
Requires (Dev)
- phan/phan: ^5.4
- phpmd/phpmd: ^2.15
- phpunit/phpunit: ^10.5
- squizlabs/php_codesniffer: ^3.9
README
A template/boilerplate for PHP libraries.
Overview
Features
- GitHub Actions runner
- Composer dependency management
- PHPUnit unit tests
- PHAN static analysis
- PHPCS coding standard analyzer
- PHPMD mess detector
- Codecov code coverage analysis
- Codacy code quality analysis
- phpDocumentor auto generated API docs
- ReadTheDocs documentation builder
Requirements
- PHP 8.1+
Documentation
- The user manual is at https://php-library-template.readthedocs.io/ (sources)
- An API documentation created with phpDocumentor can be found at https://chillerlan.github.io/php-library-template/
Disclaimer
Use at your own risk!