template-php

1. About project
2. Set up project
   • Prerequisites
   • Installation
   • Execute project
   • Execute all tests
3. Unit Tests
   • PHP Unit
4. Functional Tests
   • Behat
5. Code Quality Checker Tools
   • PHP_CodeSniffer
   • PHPStan
   • PHP Mess Detector
   • PHP Magic Number Detector
   • PHP Copy Paste Detector
   • Churn-php
   • PhpDeprecationDetector
6. Code Analysis Tools
   • Deptrac
7. License

About project

• PHP 8.1
• Docker
• Makefile
• Unit tests: PHP Unit
• Functional tests: Behat
• Code Quality Checker Tools: PHP_CodeSniffer, PHPStan, PHP Mess Detector, PHP Magic Number Detector, PHP Copy Paste Detector, Churn-php, PhpDeprecationDetector
• Code Analysis Tools: Deptrac

Set up project

Prerequisites

• Docker & Docker Compose
• Make: windows users go here

Installation

Clone repository:

git clone https://github.com/burus86/template-php.git
cd template-php

Build and up docker containers:

make start

Install composer dependencies:

make install

Execute project

Open in your favorite web browser the website http://localhost:8080/.

Execute all tests

To run all the tests (unit tests, functional tests, code quality checker tools and code analysis tools), just execute the command make test with option -i or --ignore-errors:

make test -i

If you prefer, it's also possible to run each individual test following the instructions below.

Unit Tests

PHP Unit

make test-phpunit

Functional Tests

Behat

make test-behat

Code Quality Checker Tools

PHP_CodeSniffer

make test-phpcs

In order to automatically correct coding standard violations, execute:

make test-phpcbf

PHPStan

make test-phpstan

PHP Mess Detector

make test-phpmd

PHP Magic Number Detector

make test-phpmnd

PHP Copy Paste Detector

make test-phpcpd

Churn-php

churn-php is a package that helps you identify php files in your project that could be good candidates for refactoring.

make test-churn

PhpDeprecationDetector

make test-phpdd

Code Analysis Tools

Deptrac

make test-deptrac

License

This project is licensed under the MIT License - see the LICENSE file for details.