Use Composer to get Drupal + Commerce 2.x with all dependencies.
Based on drupal-composer/drupal-project.
First you need to install composer.
Note: The instructions below refer to the global composer installation. You might need to replace
composer
withphp composer.phar
(or similar) for your setup.
After that you can create the project:
composer create-project drupalcommerce/project-base some-dir --stability dev --no-interaction
Done! Use composer require ...
to download additional modules and themes:
cd some-dir
composer require "drupal/devel:1.x-dev"
The composer create-project
command passes ownership of all files to the
project that is created. You should create a new git repository, and commit
all files not excluded by the .gitignore file.
- Drupal is installed in the
web
directory. - Modules (packages of type
drupal-module
) are placed inweb/modules/contrib/
- Theme (packages of type
drupal-theme
) are placed inweb/themes/contrib/
- Profiles (packages of type
drupal-profile
) are placed inweb/profiles/contrib/
- Creates default writable versions of
settings.php
andservices.yml
. - Creates the
web/sites/default/files
directory. - Latest version of DrupalConsole is installed locally for use at
bin/drupal
.
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
orrobots.txt
. - Commit everything all together in a single commit, so
web
will remain in sync with thecore
when checking out branches or runninggit 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.
With using the "Composer Generate" drush extension
you can now generate a basic composer.json
file from an existing project. Note
that the generated composer.json
might differ from this project's file.
Composer recommends no. They provide argumentation against but also workrounds if a project decides to do it anyway.
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": {
"drupal-scaffold": "DrupalComposer\\DrupalScaffold\\Plugin::scaffold",
"post-install-cmd": [
"@composer drupal:scaffold",
"..."
],
"post-update-cmd": [
"@composer drupal:scaffold",
"..."
]
},
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 to patch"
}
}
}
It is possible to use frontend libraries with composer thanks to the asset-packagist repository (https://asset-packagist.org/).
For example, to use colorbox:
composer require npm-asset/colorbox:"^0.4"
Composer will detect new versions of the library that meet your constraints. In the above example it will download anything from 0.4.* series of colorbox.
When managing libraries with composer this way, you may not want to add it to version control. In that case, add specific directories to the .gitignore file.
# Specific libraries (which we manage with composer)
web/libraries/colorbox
For more details, see https://asset-packagist.org/site/about
Currently Drupal 8 supports PHP 5.5.9 as minimum version (see Drupal 8 PHP requirements), however it's possible that a composer update
will upgrade some package that will then require PHP 7+.
To prevent this you can add this code to specify the PHP version you want to use in the config
section of composer.json
:
"config": {
"sort-packages": true,
"platform": {"php": "5.5.9"}
},