README

Bored of manually setting up your PHP projects ?
This is the solution !

Description

This is a skeleton for PHP projects that focus on code quality.
It contains pretty much everything you need to start a new project :

Code quality
- A working unit test (using PHPUnit) to bootstrap your coding experience
- Static analyis tools (phpcs, phpstan, psalm, phpmd and phan) to enforce the quality of your code
- A mutation testing framework (Infection) to enforce the quality of your tests
- An automated refactoring tool (Rector) to help you keep your code up to date
- Composer scripts to easily use all the above
Infrastructure
- Docker support
  - A Makefile to manage docker commands with ease
- GitHub workflows to automatically run the tests and quality tools on every push and pull request
  - It also uploads a code coverage report to CodeCov

To create a new project based on this skeleton, run the following command:

composer create-project ingenioz-it/php-skeleton {PROJECT_NAME}

PHP 8.4+ or Docker.

Create the Docker container and start a shell inside it:

make cli

composer install

make test

The previous steps went well ?

You are now ready to start coding !

The project comes with a few useful scripts to help you manage docker and run the various quality scripts.

You can list them by running

make help

Make the project truly yours by doing the following: