This project encompasses the Drupal 8 multisite platform for Creighton University marketing sites.

• UCOM focused Documentation
• Dev Team Documentation

• Getting Started - Mac
• Get Code
• Local Environment Setup
• Virtual Machine
• Working With BLT
• Resources

This project is based on BLT, an open-source project template and tool that enables building, testing, and deploying Drupal installations following Acquia Professional Services best practices. While this is one of many methodologies, it is our recommended methodology.

• Review the Required / Recommended Skills for working with a BLT project
• Ensure that your computer meets the minimum installation requirements (and then install the required applications). See the System Requirements for more information.
  • If you don't have XCode installed:
    • sudo xcodebuild -license
    • xcode-select --install
  • If you don't have Homebrew installed:
    • /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
  • PHP 7.1, Composer, and Git are required. Use Homebrew to install whichever dependencies are missing from your computer:
    • brew install php71 mcrypt git composer
    • composer global require "hirak/prestissimo:^0.3"
  • In order to run the Drupal VM, Virtualbox and Vagrant are required:
    • brew tap caskroom/cask
    • brew cask install virtualbox vagrant
    • vagrant plugin install vagrant-hostsupdater
• Request access to the cu-webteam github organization
• Request access to the Acquia Cloud Environment for your project
• Set up an SSH key that can be used for Github and Acquia Cloud (you CAN use the same key)
  • Set up Acquia Cloud SSH Keys
  • Set up Github SSH Keys

~ git clone [email protected]:cu-webteam/d8-platform.git

BLT requires a local environment that implements a LAMP stack. While out of the box templates are provided for Drupal VM, if you prefer you can use another tool such as Docker, Docksal, Lando, (other) Vagrant, or your own custom LAMP stack. BLT works with any local environment, however support is limited for these solutions.

• Open the project directory in your preferred text editor/IDE

• Create a composer.required.json in the blt directory and paste in the following:

{
  "repositories": {
    "drupal": {
      "type": "composer",
      "url": "https://packages.drupal.org/8"
    }
  },
  "require": {
    "drupal/core": "^8.5.0",
    "drupal/config_split": "^1.0.0"
  },
  "require-dev": {
    "behat/behat": ">=3.1 <3.4",
    "behat/mink": "~1.7",
    "behat/mink-selenium2-driver": "^1.3.1",
    "bex/behat-screenshot": "^1.2",
    "drupal/drupal-extension": "~3.2",
    "drupal-composer/drupal-scaffold": "^2.1.0",
    "jarnaiz/behat-junit-formatter": "^1.3.2",
    "se/selenium-server-standalone": "^2.53",
    "jakoch/phantomjs-installer":   "2.1.1-p07",
    "dmore/behat-chrome-extension": "^1.0.0",
    "mikey179/vfsStream": "~1.2",
    "sensiolabs-de/deprecation-detector": "dev-master"
  },
  "autoload-dev": {
    "psr-4": {
      "Drupal\\Tests\\PHPUnit\\": "tests/phpunit/src/"
    }
  },
  "autoload": {
    "psr-4": {
      "Acquia\\Blt\\Custom\\": "src/"
    }
  },
  "extra": {
    "composer-exit-on-patch-failure": true,
    "drupal-scaffold": {
      "initial": {
        "sites/default/default.services.yml": "sites/default/services.yml",
        "sites/default/default.settings.php": "sites/default/settings.php"
      }
    },
    "enable-patching": true,
    "patches": {
      "drupal/core": {
        "Clear Twig caches on deploys": "https://www.drupal.org/files/issues/2752961-130.patch"
      }
    }
  },
  "scripts": {
    "blt-alias": "blt blt:init:shell-alias -y --ansi",
    "drupal-scaffold": "DrupalComposer\\DrupalScaffold\\Plugin::scaffold",
    "nuke": [
      "rm -rf vendor composer.lock docroot/core docroot/modules/contrib docroot/profiles/contrib docroot/themes/contrib",
      "@composer clearcache --ansi",
      "@composer install --ansi"
    ],
    "install-phantomjs": [
      "rm -rf vendor/bin/phantomjs",
      "PhantomInstaller\\Installer::installPhantomJS"
    ]
  }
}

• Create a composer.suggested.json in the blt directory and paste in the following:

{
  "repositories": {
    "asset-packagist": {
      "type": "composer",
      "url": "https://asset-packagist.org"
    }
  },
  "require": {
    "acquia/lightning": "^3.1.0",
    "drupal/acquia_connector": "^1.5.0",
    "drupal/acquia_purge": "^1.0-beta3",
    "drupal/cog": "^1.0.0",
    "drupal/devel": "^1.0.0",
    "drupal/qa_accounts": "^1.0.0-alpha1",
    "drupal/memcache": "^2.0-alpha5",
    "drupal/seckit": "^1.0.0-alpha2",
    "drupal/security_review": "*",
    "drupal/shield": "^1.0.0",
    "drupal/features": "^3.7.0"
  },
  "extra": {
    "patches": {
    }
  }
}

• Install Composer Dependencies (warning: this can take some time based on internet speeds)

~ composer install

• Check VirtualBox to ensure that you do not already have a VM named local.creighton.com - if you do, delete it. When prompted, select 'remove all files'.

• Check your hosts file to ensure that you do not already have entries for local.creighton.com - if you do, delete them.

• Create a file in the blt directory named local.blt.yml

• Build the vm using BLT

~ blt vm

a) Drupal VM is not currently installed. Install it now? (y/n) y

b) Which base box would you like to use? 0

c) Do you want to boot Drupal VM? (y/n) y

d) creighton: Pruning invalid NFS exports. Administrator privileges will be required...

~ vagrant ssh
~ blt setup

a) You are about to DROP all tables in your 'drupal' database. Do you want to continue? (yes/no) [yes]: yes

• Access the site and do necessary work at local.creighton.com by running

~ drush uli

BLT 9 and Drush 9 require all blt and drush commands to be executed inside of the VM. Because of this requirement, the VM must have SSH access to Acquia.

~ cd ~/.ssh
~ ssh-keygen -b 4096

• The public key needs to be added to your Acquia Cloud account. More detail can be found about that here.

• Install Drush Launcher, using the instructions in this Github repository.

Additional BLT documentation may be useful. You may also access a list of BLT commands by running

~ blt

Note the following properties of this project:

• Primary development branch: master - deploys to dev environment in ACSF
  • feature branching - branching per feature
• Local environment: local
• Local site URL: local.creighton.com

BLT projects are designed to instill software development best practices (including git workflows).

Our BLT Developer documentation includes an example workflow.

BLT uses a number of configuration (.yml or .json) files to define and customize behaviors. Some examples of these are:

• blt/blt.yml (formerly blt/project.yml prior to BLT 9.x)
• blt/local.blt.yml
• box/config.yml - Drupal VM configuration
• drush/sites - contains Drush aliases for this project
• composer.json - includes required components, including Drupal Modules, for this project

• Acquia Cloud
• Acquia Cloud Sitefactory