Skip to content

Latest commit

 

History

History
64 lines (48 loc) · 4.41 KB

README.md

File metadata and controls

64 lines (48 loc) · 4.41 KB
Raw

LCM Drupal 8 Scaffolding

Build Status Dependency Status

This 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

Initial Project Setup

(These are only needed for creating a new project repository. Remove this section of the readme once you are done.)

  1. Run the following command to clone this project down. Replace PROJECTNAME with the name of the folder you want to create for the project.
composer create-project lastcall/drupal-scaffold PROJECTNAME
  1. Configure nvm to use the latest stable version nvm install stable; nvm use stable;
  2. From the docroot: npm install to install nodejs dependencies.
  3. From the docroot: gulp install (or node_modules/.bin/gulp install if you don't have gulp installed globally) to install bower and composer dependencies.
  4. Edit the composer.json, package.json, and bower.json and rename the project as needed.
  5. Rename the scaffold theme to match the project (including JS and SCSS files).
  6. Initialize a new git repository and push work to it as normal

Getting started on an already prepared project

(These will be used when working from a repo already prepared for a specific project)

  1. Clone the repository to your local environment
  2. Initalize nvm: nvm install
  3. Install node packages: npm install
  4. Install composer and bower packages: gulp install (or node_modules/.bin/gulp install if you don't have gulp installed globally)
  5. Commit and push work to repository as normal

Adding Modules/Themes

You can use composer to bring in modules and themes. Just run:

composer require drupal/ctools

Contributed modules and themes are .gitignored by default, meaning you need to run gulp install each time you clone the repository down.

Customizing the docroot

This tool is pre-configured for use on Pantheon. Using it on Acquia or another host may require some adjustment of the docroot folder (currently web/). We've tried to comment with "@docroot" in any locations where the docroot path is hard-coded to web/.

Using the Docker Images

Default configuration

To use the standard configuration, just run docker-compose up. This makes the site available behind Varnish at http://localhost/8080.

Development configuration

The default setup only exposes port 80 from varnish to the outside world (exposed as port 8080 to the host). This is great for production-like environments, but not for development where you may not want a reverse proxy, or you may need to connect directly to MySQL using a tool like Sequel Pro.

The standard docker-compose.yml can be overridden/added to by specifying multiple compose files when bringing the containers online. This project includes a docker-compose.debug.yml file that exposes ports for all of the relevant containers, allowing direct access to them from the host. You can leverage these debug ports by bringing the containers up with this command: docker-compose -f docker-compose.yml -f docker-compose.debug.yml up

When the debug ports are exposed, the following services are available from the host:

  • Varnish: You can still access the site behind varnish as you would with only the default config at http://localhost:8080
  • Drupal: You can directly access the Drupal site, bypassing the reverse proxy at http://localhost:8081
  • MySQL: You can make a direct connection from the command line using mysql -h 127.0.0.1 --port 33306 -u drupal -pdrupal drupal
  • Solr: The Solr web ui can be accessed at http://localhost:8983