“how do I _____ on my local machine?”
- (re)Install Drupal
- Update dependencies (module, theme, core, etc.)
- Patch a project
- Deploy to cloud
- Run tests & code validation
- Build frontend assets
Pre-requisites to installation:
- Ensure that
docroot/sites/default/settings/local.settings.php
exists by executing./task.sh setup:drupal:settings
. - Verify that correct local database credentials are set in
local.settings.php
. - Ensure that project dependencies have already been built via
./task.sh setup:build:all
To re-install Drupal, execute: ./task.sh setup:drupal:install
. Note that this
will drop the existing database tables and install Drupal from scratch!
All dependencies are managed in make.yml
. To update a dependency, change the
version number in make.yml
and execute ./task setup:build:all
to rebuild
the docroot with the updated dependencies.
If you are using a dev version of a given module, you should specify a specific revision id in addition to the version. See Drush Make docs for more information.
Please see patches/README.md for information on patch naming, patch application, and patch contribution guidance.
Please see Deploy for a detailed description of how to deploy to Acquia Cloud.
Please see tests/README.md for information on running tests.
To execute PHP codesniffer and PHP lint against the project codebase, run:
./task.sh validate:all
Ideally, you will be using a theme that uses SASS/SCSS, a styleguide, and other tools that require compilation. Like dependencies, the compiled assets should not be directly committed to the project repository. Instead, they should be built during the creation of a production-ready build artifact.
Bolt only natively supports the Acquia PS Thunder base theme.
To install Thunder's dependencies:
- See Acquia PS Thunder for system requirements.
- Execute
/.task frontend:install
.
To build Thunder's assets, execute:
/.task frontend:build
.