diff --git a/DOCKER_TIPS.md b/DOCKER_TIPS.md index feff587..3660526 100644 --- a/DOCKER_TIPS.md +++ b/DOCKER_TIPS.md @@ -31,7 +31,7 @@ docker system prune * `username: mariadb_user` * `password: mariadb_pass` -## Running Xdebug with PHPStorm alongside Docker +## Running Xdebug with PhpStorm alongside Docker From Docker versions 18.03 and above, Docker creates a special DNS name that resolves to the internal IP address used by the host. diff --git a/README.md b/README.md index 50ce528..47585b6 100644 --- a/README.md +++ b/README.md @@ -58,5 +58,5 @@ Inside the `scripts` folder you will find one-off scripts to help with tasks. ## Docs * [Setting up Nginx-Proxy](docs/nginx-proxy/README.md) -* [Setting up PHP Testing in PHPStorm](docs/phpstorm-docker/README.md) +* [Setting up PHP Testing in PhpStorm](docs/phpstorm-docker/README.md) * [Leveraging Yii2 Shell](docs/yii2/yii-shell.md) diff --git a/docs/phpstorm-docker/README.md b/docs/phpstorm-docker/README.md index 1773250..441478e 100644 --- a/docs/phpstorm-docker/README.md +++ b/docs/phpstorm-docker/README.md @@ -1,11 +1,11 @@ -# PHPStorm & Docker +# PhpStorm & Docker -The goal for this tutorial is to help containerize an application to leverage the tools within PHPStorm (Test Suite, +The goal for this tutorial is to help containerize an application to leverage the tools within PhpStorm (Test Suite, Coverage, etc). To do this the following things need to happen: -1) Setup Docker for Mac in PHPStorm. +1) Setup Docker for Mac in PhpStorm. 2) Setup Language (PHP in this example) to use a remote interpreter. 3) Fix the paths to match our standard (/code for project code) 4) Setup Tests (PHPUnit or Codeception) to use a special docker-compose file. @@ -16,7 +16,7 @@ We are assuming the following things: 2) The project is already running via (docker-compose up --build) 3) Some small knowledge of Docker -## Setup Docker for Mac in PHPStorm +## Setup Docker for Mac in PhpStorm Head to Preferences and go to `Build, Execution, Deployment -> Docker`. Create an item called "Docker" using the daemon option "Docker for Mac". @@ -25,7 +25,7 @@ using the daemon option "Docker for Mac". ### Creating an isolated docker-compose for testing -In order for PHPStorm to run tests without affecting containers. You need to create a new container that matches +In order for PhpStorm to run tests without affecting containers. You need to create a new container that matches whatever container your code works on. For example, here a random PHP project `docker-compose-phpstorm.yml` file. @@ -102,4 +102,4 @@ This can be shown below: ![phpstorm-seeing-green-test](./assets/docker-testpass.png) -With that you have successfully hooked the test suites, while keeping Docker inside PHPStorm. +With that you have successfully hooked the test suites, while keeping Docker inside PhpStorm.