diff --git a/readme.md b/readme.md index 227b69c..93d67ea 100644 --- a/readme.md +++ b/readme.md @@ -1,6 +1,8 @@ +![He's watching you](toby.png) + # Toby -HR software you love to hate +> HR software you love to hate ## Local setup @@ -39,19 +41,22 @@ HR software you love to hate dcr node npm run dev -## Available containers (local) +### Available containers (local) + +- **web** - nginx HTTP server - **php** - php and composer stuff - **node** - npm stuff - **mysql** - database for local development - **mailhog** - for emails preview -## Running tests +### Running tests + If xDebug is installed, set environment variable **XDEBUG_MODE=off** to improve performance dcr -e XDEBUG_MODE=off php php artisan test +### Code style check -## Code style check dcr php php vendor/bin/ecs check dcr php composer ecs dcr php php vendor/bin/ecs check --fix @@ -59,13 +64,14 @@ If xDebug is installed, set environment variable **XDEBUG_MODE=off** to improve dcr node npm run lint dcr node rpm run lintf -## xDebug +### xDebug -To use xDebug you need to set `DOCKER_INSTALL_XDEBUG` to `true` in `.env` file.\ -Then rebuild php container `docker-compose up --build -d php`.\ -You can also set up xDebug params (see docs https://xdebug.org/docs/all_settings) in `docker/dev/php/php.ini` file: +* To use xDebug you need to set `DOCKER_INSTALL_XDEBUG` to `true` in `.env` file. +* Then rebuild php container `docker-compose up --build -d php`. +* You can also set up xDebug params (see docs https://xdebug.org/docs/all_settings) in `docker/dev/php/php.ini` file: Default values for xDebug: + ``` xdebug.client_host=host.docker.internal xdebug.client_port=9003 @@ -74,16 +80,19 @@ xdebug.start_with_request=yes xdebug.log_level=0 ``` -### Disable xDebug -it is possible to disable the Xdebug completely by setting the option **xdebug.mode** to **off**, -or by setting the environment variable **XDEBUG_MODE=off**\ -See docs (https://xdebug.org/docs/all_settings#mode) +#### Disable xDebug + +* It is possible to disable the Xdebug completely by setting the option **xdebug.mode** to **off**, or by setting the environment variable **XDEBUG_MODE=off**. +* See docs: (https://xdebug.org/docs/all_settings#mode) CLI: + ``` XDEBUG_MODE=off php artisan test ``` + Docker container: + ``` docker-compose run --rm -e XDEBUG_MODE=off php php artisan test ``` \ No newline at end of file diff --git a/toby.png b/toby.png new file mode 100644 index 0000000..7fe0ec0 Binary files /dev/null and b/toby.png differ