hughestech/project-base

Commerce 2.x project template

dev-master 2017-08-31 10:36 UTC

Requires

• ext-curl: *
• composer/installers: ^1.2
• cweagans/composer-patches: ^1.6
• drupal-composer/drupal-scaffold: ^2.2
• drupal/admin_toolbar: ~1.0
• drupal/commerce: ~2.0
• drupal/console: ~1.0
• drupal/core: ~8.3.0
• drupal/search_api: ~1.0
• drupal/swiftmailer: ~1.0
• hughestech/commerce_base: dev-master
• webflo/drupal-finder: ^0.3.0
• webmozart/path-util: ^2.3

Requires (Dev)

• behat/mink: ~1.7
• behat/mink-goutte-driver: ~1.2
• jcalderonzumba/gastonjs: ~1.0.2
• jcalderonzumba/mink-phantomjs-driver: ~0.3.1
• mikey179/vfsstream: ~1.2
• phpunit/phpunit: >=4.8.28 <5
• symfony/css-selector: ~2.8

Conflicts

• drupal/drupal: *

GPL-2.0+

README

Use Composer to get Drupal + Commerce 2.x with all dependencies.

Based on drupal-composer/drupal-project.

Usage

First you need to install composer.

Note: The instructions below refer to the global composer installation. You might need to replace composer with php composer.phar (or similar) for your setup.

After that you can create the project:

composer create-project hughestech/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.

What does the template do?

• Drupal is installed in the web directory.
• Modules (packages of type drupal-module) are placed in web/modules/contrib/
• Theme (packages of type drupal-theme) are placed in web/themes/contrib/
• Profiles (packages of type drupal-profile) are placed in web/profiles/contrib/
• Creates default writable versions of settings.php and services.yml.
• Creates the web/sites/default/files directory.
• Latest version of DrupalConsole is installed locally for use at bin/drupal.

Updating Drupal Core

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.

1. Run composer update drupal/core --with-dependencies to update Drupal Core and its dependencies.
2. 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 or robots.txt.
3. Commit everything all together in a single commit, so web will remain in sync with the core when checking out branches or running git bisect.
4. 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.

Generate composer.json from existing project

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.

FAQ

Should I commit the contrib modules I download?

Composer recommends no. They provide argumentation against but also workrounds if a project decides to do it anyway.

Should I commit the scaffolding files?

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 @drupal-scaffold as post-install and post-update command in your composer.json:

"scripts": {
    "drupal-scaffold": "DrupalComposer\\DrupalScaffold\\Plugin::scaffold",
    "post-install-cmd": [
        "@drupal-scaffold",
        "..."
    ],
    "post-update-cmd": [
        "@drupal-scaffold",
        "..."
    ]
},

How can I apply patches to downloaded modules?

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"
        }
    }
}