local_dev_env.md

Local development environment

Docker based

When ever possible, we prefer Docker based local development.

For sites hosted on Amazee.io, there is additional information here.

Requirements

OSX / macOS

• Docker and Cachalot
• Docker for Mac and Pygmy

Linux

• Docker and Pygmy

Setup workflow

• Start Cachalot or Pygmy
• Clone project repository
• Build the codebase
• Start Docker environment with docker-compose up -d
• Login to container with docker-compose exec --user drupal drupal bash
• Get database and files and put in place
• Set up PhpStorm + Xdebug
• Develop

Vagrant based

Currently the default option for most projects. Project is developed on top of infra created for the project. Infra repository has Vagrant configuration with Ansible provision.

Requirements

• Ansible
• Vagrant
• VMWare Fusion or Virtualbox
• Access to project infra repository
• Access to project repository

Setup workflow

• Clone infra repository
• Clone project repository
• Build the codebase
• Create Vagrant machine with vagrant up (this will also provision it)
• Get database and files and put in place
• Put IP address to /etc/hosts
• Develop