Development environment

Set up environment for Drupal development on various operating systems.

Select your operating system from below, and follow the instructions to setup your development environment and prepare to install the City of Boston Drupal 8 website.

All Environments

1. Generate and register ssh key with GitHub

Tip

You can (re)use an existing key on your development computer, so long as it meets the requirements of GitHub.

How to create SSH keys for github

Be sure you load the public keys you create into GitHub.

2. Register ssh key with Acquia

Tip

You can (re)use an existing key on your development computer, so long as it meets the requirements of Acquia.

Linux

City of Boston recommend the Ubuntu 16.04 or later distribution. While other Linux distributions will operate well, the instructions below assume the use of Ubuntu and, in particular, the apt package manager.

3. Install Git

apt-get update
apt-get install git

4. Install Docker

apt-get update
apt-get install docker

Check Docker pre-requisites.

sudo curl -L https://github.com/docker/compose/releases/download/1.22.0/docker-compose-$(uname -s)-$(uname -m) -o /usr/local/bin/docker-compose    
sudo chmod +x /usr/local/bin/docker-compose

If using PHPStorm, install Docker-machine

base=https://github.com/docker/machine/releases/download/v0.14.0 &&
curl -L $base/docker-machine-$(uname -s)-$(uname -m) >/tmp/docker-machine &&
sudo install /tmp/docker-machine /usr/local/bin/docker-machine

5. Install Lando

apt-get update
apt-get install lando

MacOS

Windows

All Environments

Install IDE and configure debugger [optional].

There are many IDE's capable of being used to write, verify and deploy PHP code. City of Boston do not endorse any particular platform, but have successfully used the following:

• Notepad++ (basic text editor)

• Sublime Text (improved text editor)

• VIM (Linux-based advanced text editor)

• Visual Studio Code (full IDE)

• Eclipse (full IDE)

• PHPStorm (full IDE)