shahinam/shade

A Drupal distribution based on Lightning, with commonly used components.

Drupal Shade

Shade is built using Acquia Lightning distibution., _(*1)

Installing

The easiest way to install is using Composer-based project template., _(*2)

$ composer create-project shahinam/shade-project MY_PROJECT

Alternatively, you can build using the provided scripts., _(*3)

$ git clone git@github.com:shahinam/shade.git
$ cd shade
$ ./scripts/build.sh ~/Sites/myproject

This will build the project in the provided destination i.e ~/Sites/myproject in this case., _(*4)

NOTE: This will base your build based on current branch, if you want build from a different branch or tag. Use git checkout command to switch to the intended branch or tag., _(*5)

Developing locally and contributing

If you'd like to contribute, you will need to setup dev build locally. Use the command below to achive this., _(*6)

$ git clone git@github.com:shahinam/shade.git
$ cd shade
$ ./scripts/build-dev.sh shade-dev

This will create the build shade-dev in the same parent directory as shade. The new build will have a composer dependency on your local clone of shade via a ../shade symlink. You can therefore make changes to files in shade and see them immediately reflected in your dev build., _(*7)

Basic composer usage

Install a module

composer require drupal/<module-name>

Examples, _(*8)

composer require drupal/devel
composer require drupal/ctools

This will install latest available version. If you want to specify a version, _(*9)

composer require drupal/<module-name>:<version>

Update a module

composer update drupal/<module-name>