kgaut/drupal-site-scaffolder

Composer template for a drupal website

Drupal Site Scaffolder

Main goal

Easily start a new Drupal 7 / 8 project with main modules built over composer, _(*1)

Dependencies

This scaffolder require composer, a PHP dependencies manager., _(*2)

What it does ?

It will download the last 7.x or 8.x release of Drupal, and a list of useful modules., _(*3)

It copy the default.settings.php to settings.php, create the files and tmp folder (within sites/default)., _(*4)

The .gitignore file is here to prevent you to put under versioning core and modules. (See .gitignore section for more information.), _(*5)

At the end, a script ask you if you want to create a MySQL database., _(*6)

Get started

Open a terminal and move to the folder you want to use, it should be empty, then launch the command :, _(*7)

For Drupal 7 : composer create-project kgaut/drupal-site-scaffolder ./ "7.*", _(*8)

For Drupal 8 : composer create-project kgaut/drupal-site-scaffolder ./ "8.*", _(*9)

The script is loooong and it does not output much, if you wish, you can use -vvv parameter in order to set it more verbose., _(*10)

For Drupal 7 : composer create-project kgaut/drupal-site-scaffolder ./ "7.*" -vvv, _(*11)

For Drupal 8 : composer create-project kgaut/drupal-site-scaffolder ./ "8.*" -vvv, _(*12)

If you'd rather install it in a custom folder you can specify it with :, _(*13)

For Drupal 7 : composer create-project kgaut/drupal-site-scaffolder my_custom_folder "7.*", _(*14)

For Drupal 8 : composer create-project kgaut/drupal-site-scaffolder my_custom_folder "8.*", _(*15)

.gitignore

As said previously, the .gitignore file is here to prevent you to put under versioning core and modules., _(*16)

The modules within sites/*/modules/contrib/ are excluded, your customs modules has to be under sites/*/modules/ in order to not being ignored. (ie : sites/all/modules/my_module will be versioned but not sites/all/modules/contrib/views), _(*17)

Same thing for themes, within sites/*/themes/contrib/ are excluded, those under sites/*/theme/ are not. (ie : sites/all/themes/my_theme will be versioned but not sites/all/themes/contrib/zen), _(*18)

Add contributed modules and themes

Composer use the Drupal Packagist repository in order to download / update modules., _(*19)

If you want to add a module or a theme, let's say zen base theme for example type the following command :, _(*20)

composer require drupal/zen:"7.*"

Update drupal core and contrib modules

In order to update core and modules, you should launch the command, _(*21)

composer update

It will update the composer.lock file with the new version for updated dependencies., _(*22)

If you prefer to check the available updates you can do a dry run :, _(*23)

composer update --dry-run

this will only simulate the changes., _(*24)

Also you can update only one dependency by specifying it :, _(*25)

composer update drupal/zen

Use patchs for core and modules

If you need to patch core or a module, thanks to cweagans/composer-patches, you can !, _(*26)

Within the patches section add and adapt the following example :, _(*27)

"drupal/twitter": {
  "Allow to add tracking arguments to URL": "https://www.drupal.org/files/issues/twitter-post-allow-to-add-tracking-to-url-2582287-6.patch"
}

The key specify the module to patch (here : twitter), then the array contains a list of patches, the key is a description, the value is the path to the patch, it could be an url, or a relative path to a file on your system., _(*28)

Complete example :, _(*29)

"patches": {
  "drupal/twitter": {
    "Allow to add tracking arguments to URL": "https://www.drupal.org/files/issues/twitter-post-allow-to-add-tracking-to-url-2582287-6.patch"
  }
}

Links

• The project on Packagist

Thanks to

Based on the work of webflo on drupal-project., _(*30)