Composer template for Drupal projects

Package features

Asset packagist support

The Asset packagist package acts as a bridge between Composer and the popular NPM and Bower repositories, which catalog thousands of useful front-end and JavaScript packages. This allows developers to easily pull in packages like DropZoneJS and many others without requiring local Node.js to be installed.

Read more: https://lightning.acquia.com/blog/round-your-front-end-javascript-libraries-composer

Guardr core security

Guardr is a Drupal distribution with a combination of modules and settings to enhance a Drupal application's security and availability to meet enterprise security requirements. This project leverages Guardr's package management and module configuration.

Sub-profile support

A Drupal core patch has been included to add support for "Sub-profiles".

See: https://www.drupal.org/node/1356276

Support for installs from existing configuration

A Drupal core patch has been included to allow projects to be installed from existing configuration.

See: https://www.drupal.org/node/2788777

Rain base profile features

The Mediacurrent Rain base install profile includes many of the most common packages pre-configured for rapid site development and optional content features.

Setting up a DDEV-Local environment

Clone this repository into the directory of your choice:

• $ git clone https://github.com/ricktorzynski/drupal-project.git

Install composer on host machine

If you haven't already, install composer:

• On MacOS brew install composer
• Otherwise, see instructions here https://getcomposer.org/

Build & Start the local environment

• $ cd
• $ ddev start
• $ ./scripts/build.sh

This script automates the following steps:

• Runs composer install
• Installs the project Drupal site

The initial pass of the build script downloads several dependencies and an intermittent internet connection will affect the initial build process.

Troubleshooting

• Ensure ddev has started without errors. Correct errors before proceeding.`

Initial Configuration

Rename & configure sample 'mis_profile' install profile

• Change this to the name of your project name
• Find and replace all instances of 'mis_profile' with your project name
• Enable desired base profile features and modules (see mis_profile.install for more instructions).

Logging In

• Use ddev . drush uli to login to your local installation.

Adding the sync folder to be used with new installs

• The first time build.sh runs successfully you will be able to export configuration back to your project's sync folder.
• Add an empty folder named 'sync' at profile/profilename/config/sync.
• Add $config_directories['sync'] = $app_root . '/profiles/profilename/config/sync'; to your local settings.php.
• Run ddev . drush cex to export configuration to the sync folder.
• Re-run $ ./scripts/build.sh to test install with sync configuration.
• Once this is working as expected, add the sync folder to git and commit.

Development Settings

• The ./web/sites/project.ddev.site/settings.local.php contains settings for customizing the development environment. This disables Drupal's built in caching and additionally activates sites/development.services.yml for further customizing the development environment.

Development Workflow

• Use Composer to add 3rd party dependencies and patches.
• Write custom modules, themes etc. to the ./web/ directory.
• Run ddev . drush cex to export Drupal configuration to the profile/profilename/config/sync folder.
• Run $ ./scripts/build.sh before starting a new ticket. Run build.sh again to test work completed prior to submitting a pull request.

Demo Content

• TBD

Additional Links

• Project Drupal Theme Guide
• ddev Documentation
• This repository created from Composer template for Drupal projects which has some addition information on usage.
• Using Composer with Drupal.