teamdeeson/d8-quickstart

Quick start template for Drupal 8 projects.

Drupal 8

The preferred way to manage Drupal 8 sites is to use composer, and the Drupal Composer project helps integrate Drupal core with composer., _(*1)

This repository provides a quick start wrapper around Drupal Composer and includes common configuration and recommended modules for Deeson Drupal 8 projects., _(*2)

Quick-start projects use composer for dependency management, including Drupal core, contrib and 3rd party libraries. The contents of docroot/ should be considered expendable during development and can be recompiled from the contents of the repository., _(*3)

We use Docker and Docker compose for managing local development and this repository comes with some default configuration for working with Docker. You are of course free to use alternatives, but additional configuration may be required., _(*4)

For drush to work with Docker, you'll need to add the following line to your /etc/hosts file: 127.0.0.1 docker.local, _(*5)

Creating a new Drupal site

You do not need to clone this repo, our quick start is checked out using composer., _(*6)

First you need to install composer., _(*7)

Then you can create a new project using composer, keep the project name short and without punctuation (e.g. myproject), _(*8)

composer create-project teamdeeson/d8-quickstart <project-name> --stability dev --no-interaction

You should now create a new git repository, and commit all files not excluded by the .gitignore file., _(*9)

git init
git add .
git commit -m "Created the project."

Required configuration

You should check through all of the services and settings files and make any required amendments. The following amendments need to be made at a minimum:, _(*10)

.env: Add your project name in here, use the same one as used with composer (e.g. myproject), _(*11)

src/settings/environment.inc: Configure your domain names, _(*12)

src/settings/01-core.settings.inc: Configure a hash salt., _(*13)

src/settings/02-shield.settings.inc: Configure basic-auth access details to protect your dev sites., _(*14)

Build and install

At Deeson we use Makefiles to orchestrate any additional tasks such as building dependencies and running tests., _(*15)

This ensures we have a universal mechanism for task running across all of our projects., _(*16)

The project can be built using the included Makefile., _(*17)

make

will build the project based on the assumed environment. This will create the docroot/ folder and build your website., _(*18)

You can specify the environment explicitly with the ENVIRONMENT variable which will add or remove dev dependencies:, _(*19)

make build ENVIRONMENT=dev

make build ENVIRONMENT=prod

You can also safely remove your docroot at any point if you need to:, _(*20)

make clean

Once you have run the build for the first time, you can setup and run your Docker environment using the following command., _(*21)

make start

You should now have several running docker containers, including nginx, php, mariadb. Run the following command to check this., _(*22)

$ docker container ls
CONTAINER ID        IMAGE                             COMMAND                  CREATED             STATUS              PORTS                                      NAMES
01b7db232917        wodby/drupal-nginx:8-1.13-2.4.2   "/docker-entrypoint.…"   3 minutes ago       Up 3 minutes        80/tcp                                     d8-quickstart_nginx
b463d169feeb        deeson/fe-node                    "bash -c 'yarn insta…"   3 minutes ago       Up 3 minutes                                                   d8-quickstart_fe-node
f487f9c5ae93        wodby/drupal-php:7.1-2.4.3        "/docker-entrypoint.…"   3 minutes ago       Up 3 minutes        9000/tcp                                   d8-quickstart_php
fd56e451e51d        wodby/mariadb:10.1-2.3.3          "/docker-entrypoint.…"   3 minutes ago       Up 3 minutes        3306/tcp                                   d8-quickstart_mariadb
53d6dcb35ee1        mailhog/mailhog                   "MailHog"                3 minutes ago       Up 3 minutes        1025/tcp, 8025/tcp                         d8-quickstart_mailhog
fb0ebe6aae0e        wodby/redis:3.2-2.1.0             "/docker-entrypoint.…"   3 minutes ago       Up 3 minutes        6379/tcp                                   d8-quickstart_redis
834f7edc1c46        wodby/drupal-solr:8-6.4-2.0.0     "docker-entrypoint-s…"   3 minutes ago       Up 3 minutes        8983/tcp                                   d8-quickstart_solr
c18f97249a71        deeson/fe-php                     "docker-php-entrypoi…"   3 minutes ago       Up 3 minutes                                                   d8-quickstart_fe-php
2ffcf9dcf72d        traefik:1.6.6-alpine              "/entrypoint.sh --do…"   23 hours ago        Up 20 hours         0.0.0.0:80->80/tcp, 0.0.0.0:443->443/tcp   traefik

The output should contain a line like this:, _(*23)

2ffcf9dcf72d        traefik:1.6.6-alpine            "/entrypoint.sh --do…"   21 hours ago        Up 18 hours         0.0.0.0:80->80/tcp, 0.0.0.0:443->443/tcp   traefik

This is the docker-proxy container. It must be running for you to view the site in browser. See dependencies section for setup instructions., _(*24)

cd docker-proxy
make start

You should now be able to access a vanilla Drupal site at https://d8-quickstart.localhost in Google Chrome. You will need to add a security exemption as Chrome will complain about the SSL certificate being unsigned., _(*25)

If you want to use other browsers you have to add an entry to your /etc/hosts file:, _(*26)

127.0.0.1 d8-quickstart.localhost

You can now run the Drupal installation, either through the interface or from the command line using:, _(*27)

make install

will install the site and associated configuration. You will be prompted to optionally perform a site install. If you proceed this will erase your existing site database., _(*28)

You can stop the docker environment at any time using the command below:, _(*29)

make stop

Your site files and database will be stored outside of docker in the .persist hidden directory., _(*30)

Managing dependencies with composer

All of your dependencies should be managed through composer. This includes any off-the-shelf code such as Drupal core, contrib modules and themes, and any 3rd party libraries., _(*31)

To add a module (e.g. redirect):

composer require drupal/redirect

To update a module (e.g. redirect):

composer update drupal/redirect

To update Drupal core:

composer update drupal/core --with-dependencies

You should commit your composer.lock file to the repository as this will guarantee that any subsequent builds will use the same exact version of all your dependencies., _(*32)

For further details, see the Drupal Composer project documentation:, _(*33)

https://github.com/drupal-composer/drupal-project#composer-template-for-drupal-projects, _(*34)

Composer project usage guide:, _(*35)

https://getcomposer.org/doc/01-basic-usage.md, _(*36)

Xdebug

You need to run sudo ifconfig lo0 alias 10.254.254.254 before Xdebug connections will work. This is usually required each time you log-in to your development machine, but is safe to run periodically., _(*37)

Running tests

This repository contains the starting point for running both Behat and PHPUnit test suites as well as Drupal coding standards checks with PHPCS., _(*38)

PHPUnit tests should be defined within you custom modules, in the tests/ sub-directory., _(*39)

Behat tests should be defined in the behat-tests directory in the project root., _(*40)

make test

will run all of the Project's automated tests., _(*41)

Project structure

behat-tests/

This contains all of the Behat tests for your project., _(*42)

config/

This contains Drupal's CMI configuration files., _(*43)

docroot/

This directory contains compiled content and should not normally be committed to your repository., _(*44)

drush/

This contains your drush site aliases file(s)., _(*45)

src/

This contains all of your project source code. As follows:, _(*46)

src/frontend/

For all your front end needs. This makes use of our front end setup, you can find out how here : https://github.com/teamdeeson/deeson-webpack-config, _(*47)

src/modules/

This is where you place your custom modules., _(*48)

Anything within src/modules/ will be made available in docroot/modules/custom/, _(*49)

src/services/

You can define your services YAML files here., _(*50)

src/settings/

This contains the Drupal site settings, extracted from settings.php as per: http://handbook.deeson.co.uk/development/drupal8/#settings-file-configuration, _(*51)

This has been moved from either sites/default/settings/ or sites/conf/ mentioned in the blog post., _(*52)

settings.php will be made available in docroot/sites/default/. All other files will be included in-place by settings.php., _(*53)

src/themes/

This is where you place your custom theme(s)., _(*54)

Anything within src/themes/ will be made available in docroot/themes/custom/, _(*55)

src/themes/deeson_frontend_framework

The default hook up between drupal and src/frontend. Your theme can either inherit from this or follow the instructions from https://github.com/teamdeeson/deeson-webpack-config to do it yourself (its not tricky)., _(*56)

scripts/

This is for any compilation or deployment scripts you may want to add., _(*57)

These need to be included in your settings file in the usual way:, _(*58)

$settings['container_yamls'][] = dirname(DRUPAL_ROOT) . '/src/services/development.services.yml';

vendor/

This is the composer vendor directory, which contains project dependencies, tools and libraries. This should be excluded from your repository., _(*59)

web/

This and docroot/ are symlinked to the same location for wider compatibility and should also be excluded from your repository., _(*60)

Helpful Docker commands

You can use the docker-compose tool as a shortcut for common docker commands. To run a command within one of the containers you can use:, _(*61)

docker-compose exec <container-name> <command>

For example to start a mysql client on the database container (mariadb) run:, _(*62)

docker-compose exec mariadb mysql

You can also use the more standard docker commands., _(*63)

To list the active Docker instances run the following in the project root directory:, _(*64)

docker-compose ps

To get a bash terminal inside the PHP container you can use the following:, _(*65)

docker-compose exec php

To import an exported site database into the database container (if you don't have pv installed you can do so with brew install pv):, _(*66)

pv database_export_filename.sql | docker-compose exec -T mariadb mysql -udrupal -pdrupal drupal

Note that this method is up to 33% faster than the drush method pv database_export_filename.sql | drush @docker sql-cli, _(*67)

Dependencies

Our Docker proxy should be installed and running. See here for installation notes: https://bitbucket.org/deesongroup6346/d4d-traefik-proxy, _(*68)

Known issues

ERROR: Network proxy declared as external, but could not be found. Please create the network manually using 'docker network create proxy' and try again., _(*69)

The Docker proxy needs to be running. See dependencies above., _(*70)

Managing Configuration

The D8 Quickstart uses Config Split to separate local development configuration from the default configuration., _(*71)

Exporting configuration

The default configuration will be exported to ./config/default by drush @docker cex., _(*72)

The local development configuration will be exported to ./config/local automatically when drush @docker cex is ran., _(*73)

You can control what is considered local configuration in the Drupal 8 admin area., _(*74)

Importing configuration

You can import the site configuration using drush @docker cim, _(*75)

The default configuration will always be imported., _(*76)

If the environment is the local development environment then the local configuration is also imported., _(*77)

Using Drush with Acquia

You may need to add the following to your ~/.ssh/config when working with Drush and Acquia remote hosts:, _(*78)

Host *.acquia-sites.com
   LogLevel QUIET