chillerlan/php-library-template

A PHP Library template/boilerplate.

dev-main 2024-07-17 02:18 UTC

Requires

• php: ^8.1

Requires (Dev)

• phpmd/phpmd: ^2.15
• phpstan/phpstan: ^1.11
• phpstan/phpstan-deprecation-rules: ^1.2
• phpunit/phpunit: ^10.5
• squizlabs/php_codesniffer: ^3.10

MIT

• smiley
• Contributors

• boilerplate
• library-template

README

A template/boilerplate for PHP libraries.

Overview

Features

• GitHub Actions runner
• Composer dependency management
• PHPUnit unit tests
• PHPStan 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!