Skip to content

Latest commit

 

History

History
100 lines (67 loc) · 4.91 KB

README.md

File metadata and controls

100 lines (67 loc) · 4.91 KB
Raw

BLTed powered by Docksal

A base or sample Drupal 9 project defined by Acquia BLT and powered by Docksal.

BLT is an open-source project template and tool that enables building, testing, and deploying Drupal installations following Acquia Professional Services' best practices.

Docksal is a Docker tool for building containerized development environments. From a zero-config setup to a fully customized build, along with the command-line tool fin, Docksal provides a powerful and flexible development platform.

Getting Started

You must first have Docksal installed and setup on your computer.

If you are using an Acquia Cloud production environment, follow instructions for adding your Acquia Cloud API key to the Docksal environment.

To use this project as a starter, clone this repo to your local machine.

From your terminal, go to the directory where you have cloned the repo and enter the following command:

fin init

A composer.lock file and a salt.txt file will be generated. These files, along with the docroot directory should be committed to your repository. When complete, you can access the site by running:

fin drush uli

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

fin blt

Additional Docksal documentation may also be helpful. You can access a list of commands simply by running:

fin

Working With a BLT Project

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

Acquia BLT Developer documentation includes an example workflow.

Important Configuration Files

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 (if using Drupal VM)
  • drush/sites (contains Drush aliases for this project)
  • composer.json (includes required components, including Drupal Modules, for this project)

Resources

This project includes the following packages and configuration:

  • Drupal core
  • Acquia BLT (Development and automation toolset)
  • Acquia Lightning (Drupal distribution)
  • Drush (Drupal CLI and development tool, via Lightning)
  • Acquia Connector (Management and reporting tool for Acquia Cloud sites, via Lightning)
  • Asset Packagist repository, package, and configuration (via Lightning)

Acquia Drupal Recommended Project

This is a project template providing a great out-of-the-box experience for new Drupal 9 projects hosted on Acquia. It is based on the Drupal Recommended Project and similar to the Acquia Drupal Minimal Project, with the principal difference being the addition of several modules and packages that provide the best possible out-of-the-box experience for Acquia customers.

This project includes the following packages and configuration:

  • Drupal core
  • Acquia BLT (Development and automation toolset)
  • Acquia Lightning (Drupal distribution)
  • Drush (Drupal CLI and development tool, via Lightning)
  • Acquia Connector (Management and reporting tool for Acquia Cloud sites, via Lightning)
  • Asset Packagist repository, package, and configuration (via Lightning)

Once you create the project, you can and should customize composer.json and the rest of the project to suit your needs. You will receive updates from any dependent packages, but not from the project template itself. It's yours to keep!

For instance, you can remove a provided package by running the following command and committing the changed composer.json and composer.lock to Git:

composer remove acquia/blt

License

Copyright (C) 2020 Acquia, Inc.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License version 2 as published by the Free Software Foundation.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

BLT v12.0.0