Here is a quick-start guide to getting your local development environment set up and getting oriented with the project standards and workflows.
Verify that your system meets System requirements
Technology Knolwedge Requirements / Recommendations¶
Verify that you have the necessary skillset(s) to interact with BLT.
Building project dependencies requires that your local machine make HTTP and HTTPS requests to various software providers on the internet. Please ensure that your local and network level security settings permit this to happen.
If you need to make requests via a proxy server, please configure git to use a proxy. This will cover all git based requests made by Composer.
- Verify that your system meets the system requirements for BLT
- Fork the primary GitHub repository
Clone your fork to your local machine:
git clone firstname.lastname@example.org:username/project-repo.git git remote add upstream email@example.com:acquia-pso/project-repo.git
If your project uses separate
developbranches, checkout the
git checkout develop
composer install(you must already have Composer installed).
composer run-script blt-alias
If your project uses a virtual development environment such as DrupalVM:
- Make sure you have installed any prerequisites. For DrupalVM, see the quick start guide.
- Start your virtual machine:
- Build and install the Drupal installation:
If your project does not use a virtual development environment:
- Setup your local LAMP stack with the webroot pointing at you project's
blt setup:settingsThis will generate
docroot/sites/default/local.drushrc.php. Update these with your local database credentials and your local site URL.
blt setup. This will build all project dependencies and install drupal.
- Create and edit your local drush alias file. Copy
drush/site-aliases/local.aliases.drushrc.php. Edit the new alias file with your local path.
Please see Local Development for more information on setting up a local *AMP stack or virtual development environment.
As development progresses, you can use the following commands to keep your local environment up to date:
blt setupto rebuild the codebase and reinstall your Drupal site (most commonly used early in development).
blt sync:refreshto rebuild the codebase, import a fresh DB from a remote environment, and run schema/configuration updates (most commonly used later in development).
Each of these commands is simply a wrapper for a number of more granular commands that can be run individually if desired (for instance,
blt setup:update just runs database updates and imports configuration changes). For a full list of available project tasks, run
blt -l. See Project Tasks for more information.
Local Git Configuration¶
For readability of commit history, set your name and email address properly:
git config user.name "Your Name" git config user.email firstname.lastname@example.org
Ensure that your local email address correctly matches the email address for your Jira account.
Updating you local environment¶
The project is configured to update the local environment with a local drush alias and a remote alias as defined in
blt/project.local.yml. Given that these aliases match, those in
drush/site-aliases/, you can update the site with BLT.
In order to more easily identify developers in a project, please 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 largely depends on your local environment, so please follow the installation instructions accordingly.
Review BLT documentation by role to learn how to perform common project tasks and integrate with third party tools.