This document is intended for developers who have joined a project that already has Acquia BLT installed. It is a quick-start guide for getting your local development environment set up and getting oriented with the project standards and workflows.
If you are attempting to add Acquia BLT to a project or create a new Acquia BLT-based project, do not use this document. Instead, refer to Installing Acquia BLT.
If you have been directed to this documentation by a project that’s using Acquia BLT to accelerate its development, testing, and deployment, we recommend exploring all of the Acquia BLT documentation first. Here’s what’s most important to do and know before getting started:
composer.json
file. This also means that you don’t need to install or
configure Acquia BLT globally on your computer, or as a separate tool—run
composer install
on the parent project and install a bash alias (as
described below), and you’re ready to go.develop
or master
). This should be referenced
in your project’s README file.Fork the primary GitHub repository for the project you are developing.
Clone your fork to your local computer. By convention, Acquia BLT refers
to your fork as origin
and the primary repository as upstream
):
git clone [email protected]:username/project-repo.git
git remote add upstream [email protected]:acquia-pso/project-repo.git
If your project uses separate master
and develop
branches,
checkout the develop
branch:
git checkout develop
With Composer already installed, run the following command:
composer install
Install blt
alias:
./vendor/bin/blt blt:init:shell-alias
At this point, restart your shell for the alias work.
If your project uses a virtual development environment (such as Drupal VM), complete the following steps:
Start the VM:
vagrant up
SSH into the VM:
vagrant ssh
Build and install the Drupal installation:
blt setup
If your project does not use a virtual development environment, complete the following steps:
Set up your local LAMP stack with the web root pointing at your project’s
docroot
directory.
Run the following command:
blt blt:init:settings
This will generate docroot/sites/default/settings/local.settings.php
and docroot/sites/default/local.drush.yml
. Update these with your
local database credentials and your local website URL.
Run the following command:
blt setup
This command will both build all project dependencies and install Drupal.
For more information about setting up a local *AMP stack or virtual development environment, see Local development with Acquia BLT.
As development progresses, you can use the following commands to keep your local environment up to date:
blt setup
to rebuild the codebase and reinstall your Drupal website
(most commonly used early in development).blt drupal:sync
to rebuild the codebase, import a fresh database
from a remote environment, and run schema and configuration updates (most
commonly used later in development).Each of these commands is a wrapper for several more granular commands that
can be run individually if desired. For instance, blt drupal:update
runs
database updates and imports configuration changes. For a full list of
available project tasks, run blt
. For more information, see
Project tasks.
For readability of commit history, set your name and email address properly:
git config user.name "Your Name"
git config user.email [email protected]
Ensure that your local email address correctly matches the email address for your JIRA account.
The project is configured to update the local environment with a local Drush
alias and a remote alias as defined in blt/blt.yml
or
blt/local.blt.yml
. Given that these aliases match those in
drush/sites/
, you can update the website with Acquia BLT.
To more easily identify developers in a project, be sure to set a name and profile picture in your GitHub profile.
When working with GitHub, the hub utility can be helpful when managing forks and pull requests. Installing hub can depend on your local environment, so follow the installation instructions accordingly.
Review Acquia BLT developer and technical architect documentation by role to learn how to perform common project tasks and integrate with third party tools.