The most easy way to set up the project is to install Docker and Docker Composer and build the project.
The configuration is shipped with a distribution environment file allowing you to customize your IDE and XDebug settings as well as your current user/group ID:
$ cp .env.dist .env
The most important part is the USER_ID
and GROUP_ID
which should match your current user/group.
Once you have configured your environment, you can build the project:
$ docker-compose build
Install the dependencies via Composer:
$ docker-compose run --rm php composer install
To run the test suite, you can use:
$ docker-compose run --rm php vendor/bin/phpunit
Lot of tests require a remote server, you can start it with:
$ docker-compose up -d
If you want to use XDebug, make sure you have fully configured your .env
file and use:
$ docker-compose run --rm -e XDEBUG=1 php vendor/bin/phpunit