prerequisites.md

Prerequisites

To use this configuration, some minor things are necessary before using this boilerplate, depending mostly on your OS.

General requirements

1. The first thing you have to do is to install the Docker runtime in your system.

   • If running MacOS or Windows as your OS you can simply install Docker desktop program.

   • If running Linux install the Docker engine first, followed by the Docker compose utility and finally follow the post install instructions.

     # Example procedure to install the runtime on a standard Ubuntu (16.04+) installation
     
     sudo apt remove docker docker-engine docker.io containerd runc
     sudo apt update
     sudo apt install apt-transport-https ca-certificates curl gnupg-agent software-properties-common
     curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -  
     sudo apt-key fingerprint 0EBFCD88
     sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable"
     sudo apt update
     sudo apt install docker-ce docker-ce-cli containerd.io
     
     # docker compose installation
     sudo apt install docker-compose
     
     # Post install steps
     sudo groupadd docker
     sudo usermod -aG docker $USER
     newgrp docker 
     sudo systemctl enable docker  
     
     # Restarting the machine, in order to have the Docker engine successfully up an running
     sudo reboot now

     If running Linux, take also note of Docker IP address by running in a terminal window the following snippet:

     ifconfig docker0 | grep inet

     The result will be something like this:

     user@example$ ifconfig docker0 | grep inet
         inet 172.17.0.1     netmask 255.255.255     broadcast 172.17.255.255

     You must take note of the first shown IP address (the one following the inet keyword).

Prerequisites for Linux 🐧

Install make, if missing from your system.

Prerequisites for MacOS

Install Docker-Sync by running in terminal gem install docker-sync.
If you ever tried to develop something with Docker on a non-Linux OS, you surely incurred in poor performances, especially on MacOS. This is due to the virtualization layer which is in the middle between the Docker runtime and the operating system. To outcome this bottleneck, the Docker-Sync utility comes to the rescue by taking care of synchronizing our sources with a virtual disk (in both directions) which will be created to run our project: this results in a noticeable performance boost.

Prerequisites for Windows

1. Install WinMake and add the bin folder of its installation path to the system PATH variable

2. From the Docker Console, enable Volume sharing. If the disk which the project has been cloned to is C:, make sure the checkbox in order for it to be mounted into Docker virtual machine.

3. Install CygWin emulator to be able to run Unix-like commands.

   1. If you want to use CygWin from PhpStorm terminal window, add the bin folder of the emulator installation path to system PATH variable and, inside IDE settings, search for Terminal and paste the following line into the shell path input field:

      "c:\CYGWIN_INSTALLATION_PATH\bin\sh" -lic 'cd "${OLDPWD-.}"; bash'

      Make sure to paste the string with all the provided quotes and replace CYGWIN_INSTALLATION_PATH with the actual installation path.