Installation Instructions

Lightning provides a Composer-based installer. Welcome to the future!

Getting Started

You will need the following installed:

  • Composer, obviously
  • Node, which includes the NPM package manager

When you have those, run this command:

$ composer create-project acquia/lightning-project:^8.1.0 MY_PROJECT --no-interaction

Composer will create a new directory called MYPROJECT containing a docroot directory with a full Lightning code base therein. You can then install it like you would any other Drupal site.

Development and Maintenance

drush make, drush pm-download, drush pm-update and their ilk are the old-school way of maintaining your code base. Forget them. You're in Composer land now!

Let this handy table be your guide:

Task Drush Composer
Fetch a contrib project (latest version) drush pm-download PROJECT composer require drupal/PROJECT:8.*
Fetch a contrib project (specific version) drush pm-download PROJECT-8.x-1.0-beta3 composer require drupal/PROJECT:8.1.0-beta3
Updating all contrib projects and Drupal core drush pm-update composer update
Updating a single contrib project drush pm-update PROJECT composer update drupal/PROJECT
Updating Drupal core drush pm-update drupal composer update drupal/core

Not too tricky, eh?

The magic is that Composer, unlike Drush, is a dependency manager. If module foo-8.x-1.0 depends on baz-8.x-3.2, Composer will not let you update baz to 8.x-3.3 (or downgrade it to 8.x-3.1, for that matter). Drush has no concept of dependency management. If you've ever accidentally hosed a site because of dependency issues like this, you've probably already realized how valuable Composer can be.

But to be clear: you still need Drush. Tasks such as database updates (drush updatedb) are still firmly in Drush's province, and it's awesome at that stuff. This installer will install a copy of Drush (local to the project) in the bin directory.

Composer is only responsible for maintaining the code base.

Source Control

If you peek at the .gitignore we provide, you'll see that certain directories, including all directories containing contributed projects, are excluded from source control. This might be a bit disconcerting if you're newly arrived from Planet Drush, but in a Composer-based project like this one, you SHOULD NOT commit your installed dependencies to source control.

When you set up the project, Composer will create a file called composer.lock, which is a list of which dependencies were installed, and in which versions. Commit composer.lock to source control! Then, when your colleagues want to spin up their own copies of the project, all they'll have to do is run composer install, which will install the correct versions of everything in composer.lock.

Powered by Drupal Lightning