Drupal 8 Site template

This repository contains the code to spin up some Docker containers from docker-compose and the Drupal code managed via composer as a template for website development.

Required

Docker Mac or Windows
Docker compose

Good to have

Composer
Drush

Steps

Clone this repository.
Run make build
Visit http://localhost:8080 in your browser

To rebuild (clearing out all existing data), run: make rebuild

Note: a full list of commands available can be found by running make help

Usage

Composer file is in the root but the web server should point to /web subfolder.
Start the machine (after build from the "Steps" section) make start
Stop the machine make stop
Help for more make commands make help

Development

Get a mysql command prompt make mysql
Open a terminal on the web server container make webshell
Open a terminal on the database server container make dbshell
require new Drupal modules make composer arg="require drupal/devel:~1.0"

You can also run commands using docker. e.g.

Run a drush command docker-compose exec web drush status
Run any composer included module e.g. Drupal Console: docker-compose exec web drupal --help

Documentation from Drupal Composer

Updating Drupal Core

This project will attempt to keep all of your Drupal Core files up-to-date; the project drupal-composer/drupal-scaffold is used to ensure that your scaffold files are updated every time drupal/core is updated. If you customize any of the "scaffolding" files (commonly .htaccess), you may need to merge conflicts if any of your modified files are updated in a new release of Drupal core.

Follow the steps below to update your core files.

Run composer update drupal/core webflo/drupal-core-require-dev symfony/* --with-dependencies to update Drupal Core and its dependencies.
Run git diff to determine if any of the scaffolding files have changed. Review the files for any changes and restore any customizations to .htaccess or robots.txt.
Commit everything all together in a single commit, so web will remain in sync with the core when checking out branches or running git bisect.
In the event that there are non-trivial conflicts in step 2, you may wish to perform these steps on a branch, and use git merge to combine the updated core files with your customized files. This facilitates the use of a three-way merge tool such as kdiff3. This setup is not necessary if your changes are simple; keeping all of your modifications at the beginning or end of the file is a good strategy to keep merges easy.

FAQ

Should I commit the contrib modules I download?

Composer recommends no. They provide argumentation against but also workrounds if a project decides to do it anyway.

Should I commit the scaffolding files?

The drupal-scaffold plugin can download the scaffold files (like index.php, update.php, …) to the web/ directory of your project. If you have not customized those files you could choose to not check them into your version control system (e.g. git). If that is the case for your project it might be convenient to automatically run the drupal-scaffold plugin after every install or update of your project. You can achieve that by registering @composer drupal:scaffold as post-install and post-update command in your composer.json:

"scripts": {
    "post-install-cmd": [
        "@composer drupal:scaffold",
        "..."
    ],
    "post-update-cmd": [
        "@composer drupal:scaffold",
        "..."
    ]
},

How can I apply patches to downloaded modules?

If you need to apply patches (depending on the project being modified, a pull request is often a better solution), you can do so with the composer-patches plugin.

To add a patch to drupal module foobar insert the patches section in the extra section of composer.json:

"extra": {
    "patches": {
        "drupal/foobar": {
            "Patch description": "URL or local path to patch"
        }
    }
}

How do I switch from packagist.drupal-composer.org to packages.drupal.org?

Follow the instructions in the documentation on drupal.org.

luisrc7 / docker-compose-drupal