lastcall/drupal-scaffold

Scaffolding for an enterprise scale Drupal build

LCM Drupal 8 Scaffolding

, _(*1)

LCM Drupal 8 Scaffolding is brought to you by your friends at Last Call Media, it is a boilerplate Drupal 8 build that bundles some standard tools to make it a good starting point for an enterprise scale Drupal build. It is conceptually similar to drupal-composer/drupal-scaffold, but it has a much simpler (and more manual) Composer setup, and includes additional tools. For additional information on this project, see the 2016 Badcamp presentation slides, _(*2)

Starting a New Project

• [ ] Use composer to create a new project, starting from this repository as a template: bash composer create-project lastcall/drupal-scaffold PROJECTNAME
• [ ] Bring up the Docker containers and enter the Drupal container. bash docker-compose up -d drupal docker-compose exec drupal /bin/bash
• [ ] From the repository root (/var/www inside the Drupal container), install NPM and composer dependencies: bash yarn install composer install
• [ ] Visit the Drupal site in your browser to install Drupal and continue. The default URL will be http://localhost:8080.

See the scaffold documentation for next steps., _(*3)

Stop here!

Everything below this line applies to scaffold projects that are already set up. The section below will be the start of your project's README., _(*4)

Setting Up for Local Development

This project is built using Drupal Scaffold. Before you begin, you must have Docker and Docker Compose installed on your local machine. For installation instructions, see the Drupal Scaffold - Docker documentation., _(*5)

1. Clone this repository.
2. If you haven't created and set your Pantheon machine token, do that now.
3. Start the Docker environment and shell in: bash docker-compose up -d drupal docker-compose exec drupal bash
4. Install Composer dependencies: bash composer install
5. Install NPM dependencies: bash yarn install

6. Run composer site:import to pull down and import a copy of the site's database. If Pantheon gives you an error here, make sure you followed Step 2 above correctly and that you're running Docker in a new terminal window, _(*6)

7. Run drupal site:mode dev to switch to dev configuration., _(*7)

8. Run gulp build (or gulp watch) and drush cr (from within the Drupal root at /var/www/web) to compile the theme., _(*8)

9. View your new local site in the browser at http://localhost:8080/., _(*9)

See the Drupal Scaffold documentation for more information on how to use the tools and how to use this project. To find more information on the Docker stack, visit the Docker documenation., _(*10)

Testing

Both testing tools listed below are using the following JSON files for switching the environments and fetching the URLs for these testing tools. If any changes are needed make changes to the files below:, _(*11)

• Environments JSON
• URLs JSON

The option to switch environments can be used by adding the following to command --target=prod. It will always default to local if no target is being used., _(*12)

Nightcrawler

Nightcrawler will run in CircleCI for each Pull Request, but if you want to test the PR locally use the following command, _(*13)

$ docker-compose run drupal node_modules/.bin/nightcrawler crawl

Backstop

Backstop is only tested manually, see documentation to test your branch., _(*14)