To run this project smoothly, you will need to install and have a basic knowledge of the following tools:
To be able to contribute, you will need a good knowledge of:
All commands are ran from the project root folder
.env.dist file in a
.env file in the root folder and define the environment variables.
This will build an initial image "app" containing:
or in the background
docker-compose up -d
No extra step should be required to get a running application.
You should now be able use your web browser to access:
Connect to the web server container
docker-compose exec app /bin/bash
run phpunit, a unit test tool. Report is generated in reports folder:
run phpmetrics tool. Report is generated in reports folder:
run phpstan tool to check style. (no reports generated => requires update in phpstan.neon):
run phpmd, a static analysis tool . Report is generated in reports folder: