isabella232 / decoupled-drupal-recommended

Pantheon's recommended project for decoupled Drupal 9 sites

Composer-enabled Decoupled Drupal Project

This is Pantheon's recommended starting point for creating new decoupled Drupal 9 backend sites. It builds on Pantheon's default Drupal 9 upstream to provide best practices, default configuration, and accellerator tools for using drupal 9 as a backend in decoupled archictures.

Unlike with earlier Pantheon upstreams, files such as Drupal Core that you are unlikely to adjust while building sites are not in the main branch of the repository. Instead, they are referenced as dependencies that are installed by Composer.

Installation

Prerequisites

• Composer (required for CMS backends): Install Globally
• Generate machine token & Authenticate into Terminus
• Install Terminus (3.0.0 above required)
• Also install the following plugins:
  • terminus self:plugin:install terminus-build-tools-plugin
  • terminus self:plugin:install terminus-power-tools
  • terminus self:plugin:install terminus-secrets-plugin
  • Reload the terminus plugins: terminus self:plugin:reload
  • Clear cache for composer: composer clear-cache
  • Validate that the required plugins are installed: terminus self:plugin:list
• Create Github Personal access tokens
• Create CircleCI Personal API Tokens

Installation via terminus build:project:create

• Run the terminus build:project:create as follows:

  terminus build:project:create \
  --team='{My Team Name}' \
  --template-repository="[email protected]:pantheon-systems/decoupled-drupal-recommended.git" pantheon-systems/decoupled-drupal-recommended \
  --ci-template='[email protected]:pantheon-systems/advanced-ci-templates' \
  --visibility private {PROJECT_NAME} \
  --stability=dev \
  --profile="pantheon_decoupled_profile"
  

  Replace {PROJECT_NAME} with your project name - for example decoupled-drupal.

  Replace '{My Team Name}' with your team name - for example My Agency. This can also be omitted.

Note: This will result in a Github repository being created for this new codebase under the authenticated user's namespace (unless the --org option is used), a site being created on Pantheon and a CircleCI project being created for automated deployments.

The project create command can be used with a variety of additional options including specifying an alternate install profile, or using a variety of CI or Git providers. For more information, consult the Additional Options section in the Decoupled Kit developer documentation.

Contributing

Contributions are welcome in the form of GitHub pull requests. However, the pantheon-systems/decoupled-drupal-recommended repository is a mirror that does not directly accept pull requests.

Instead, to propose a change, please fork pantheon-systems/decoupled-drupal and submit a PR to that repository.