Drupal Starter Kits
Installing Drupal Starter Kits through the local system
You can use your local system to create an Acquia-recommended Drupal project or add a starter kit to your existing Drupal project.
Create an Acquia-recommended Drupal project by running the following command:
composer create-project acquia/drupal-recommended-project project && cd projectBy default, the starter kit is already available in this project.
Add a starter kit to your existing Drupal project by running the following command:
composer require acquia/acquia-cms-starterkitAfter you create an Acquia-recommended Drupal project or add a starter kit to an existing Drupal project, you can install Drupal Starter Kits by leveraging one of the available starter kits. Acquia recommends that you use the Drupal Starter Kits wizard for downloading and building Drupal sites with Drupal Starter Kits modules. With this wizard, you can set up your Drupal site using one of the three starter kits. You can install Drupal Starter Kits by using one of the following starter kits:
This starter kit installs the following to your Drupal site:
It provides drag-and-drop content authoring and low-code site building. An optional add-on content model is available during the installation process. For more information, see Enterprise low-code starter kit.
To install Drupal Starter Kits through the Enterprise low-code starter kit:
Access your Drupal project and run the following command:
./vendor/bin/acms acms:install
Existing users who want to prevent rebuilding Composer dependencies repeatedly can leverage separate build and install commands. For more information, see Using separate build and install commands.
In Please choose bundle from one of the above use case, select acquia_cms_enterprise_low_code and press Enter.
For selection, you can use the Up and Down arrow keys.
The default value for this query is acquia_cms_enterprise_low_code. Therefore, the system considers the value to be acquia_cms_enterprise_low_code even if you do not specify any value.
In Do you want to enable the content model?, type yes or no and press Enter.
This question includes all content types in the site.
In Please provide the Google Maps API Key, type the Google Maps API key and press Enter.
The starter kit wizard does not prompt for the key if you have already configured the environment variable with the export GMAPS_KEY="<your_key>" command. Also, you can skip this step if you do not have the key.
In Please provide the Site Studio API Key, type the Site Studio API key and press Enter.
The starter kit wizard does not prompt for the key if you have already configured the environment variable with the export SITESTUDIO_API_KEY="<your_key>" command. Also, you can skip this step if you do not have the key.
In Please provide the Site Studio Organization Key, type the Site Studio Organization key and press Enter.
The starter kit wizard does not prompt for the key if you have already configured the environment variable with the export SITESTUDIO_ORG_KEY="<your_key>" command. Also, you can skip this step if you do not have the key.
Specify the database information, such as name, driver, username, password, host, and port.
To prevent failed installation, ensure that you:
(Optional) If you are already using the blt-site-studio plugin, remove it from your codebase by running the following command:
composer remove acquia/blt-site-studio
Remove the following lines from the blt/blt.yml file:
site-studio:
rebuild: true
package-import: true
cohesion-import: true
If you do not leverage the blt-site-studio plugin but use custom scripts instead, ensure that you remove such references from your codebase.
Add the Site Studio Configuration Management module to your codebase by running the following command:
composer require drupal/sitestudio_config_management
Enable the module by running the following command:
./vendor/bin/drush en sitestudio_config_management -y
(Optional) Add the following lines to the settings.php file:
$settings['config_sync_directory'] = '../config/default/sync';
$settings['site_studio_sync'] = '../config/default/site_studio';
settings.php file already includes the paths for the config_sync_directory and site_studio_sync parameters, you can skip this step.settings.php file. For more information, see Using the Drupal Recommended Settings plugin.Verify the configuration import and export commands by running the following commands:
./vendor/bin/drush cex
./vendor/bin/drush cim
These commands must automatically export or import Site Studio configurations along with Drupal configurations based on the paths specified in your settings.php file.
Currently, the starter kit wizard uses drush site:install and drops the database of any existing site. Therefore, you cannot use starter kits after installation.
After you install Drupal Starter Kits, you can develop your Drupal site and deploy your changes to Cloud Next.
This starter kit installs Drupal Starter Kits to your Drupal site. An optional add-on content model is available during the installation process. For more information, see Community starter kit.
To install Drupal Starter Kits through the Community starter kit:
Access your Drupal project and run the following command:
./vendor/bin/acms acms:install
Existing users who want to prevent rebuilding Composer dependencies repeatedly can leverage separate build and install commands. For more information, see Using separate build and install commands.
In Please choose bundle from one of the above use case, select acquia_cms_community and press Enter.
For selection, you can use the Up and Down arrow keys.
In Do you want to enable the content model?, type yes or no and press Enter.
This question includes all content types in the site.
In Please provide the Google Maps API Key, type the Google Maps API key and press Enter.
The starter kit wizard does not prompt for the key if you have already configured the environment variable with the export GMAPS_KEY="<your_key>" command. Also, you can skip this step if you do not have the key.
Specify the database information, such as name, driver, username, password, host, and port.
To prevent failed installation, ensure that you:
Currently, the starter kit wizard uses drush site:install and drops the database of any existing site. Therefore, you cannot use starter kits after installation.
After you install Drupal Starter Kits, you can develop your Drupal site and deploy your changes to Cloud Next.
This starter kit preconfigures Drupal for serving structured, RESTful content to third-party content displays, such as mobile apps, smart displays, and frontend driven websites. For more information, see Headless starter kit.
To install Drupal Starter Kits through the Headless starter kit:
Access your Drupal project and run the following command:
./vendor/bin/acms acms:install
Existing users who want to prevent rebuilding Composer dependencies repeatedly can leverage separate build and install commands. For more information, see Using separate build and install commands.
In Please choose bundle from one of the above use case, select acquia_cms_headless and press Enter.
For selection, you can use the Up and Down arrow keys.
In Do you want to enable the content model?, type yes or no and press Enter.
This question includes all content types in the site.
In Please provide the Google Maps API Key, type the Google Maps API key and press Enter.
The starter kit wizard does not prompt for the key if you have already configured the environment variable with the export GMAPS_KEY="<your_key>" command. Also, you can skip this step if you do not have the key.
Specify the database information, such as name, driver, username, password, host, and port.
To prevent failed installation, ensure that you:
Currently, the starter kit wizard uses drush site:install and drops the database of any existing site. Therefore, you cannot use starter kits after installation.
After you install Drupal Starter Kits, you can develop your Drupal site and deploy your changes to Cloud Next.
If this content did not answer your questions, try searching or contacting our support team for further assistance.
The default value for this query is acquia_cms_enterprise_low_code. Therefore, the system considers the value to be acquia_cms_enterprise_low_code even if you do not specify any value.
In Do you want to enable the content model?, type yes or no and press Enter.
This question includes all content types in the site.
In Please provide the Google Maps API Key, type the Google Maps API key and press Enter.
The starter kit wizard does not prompt for the key if you have already configured the environment variable with the export GMAPS_KEY="<your_key>" command. Also, you can skip this step if you do not have the key.
In Please provide the Site Studio API Key, type the Site Studio API key and press Enter.
The starter kit wizard does not prompt for the key if you have already configured the environment variable with the export SITESTUDIO_API_KEY="<your_key>" command. Also, you can skip this step if you do not have the key.
In Please provide the Site Studio Organization Key, type the Site Studio Organization key and press Enter.
The starter kit wizard does not prompt for the key if you have already configured the environment variable with the export SITESTUDIO_ORG_KEY="<your_key>" command. Also, you can skip this step if you do not have the key.
Specify the database information, such as name, driver, username, password, host, and port.
To prevent failed installation, ensure that you:
(Optional) If you are already using the blt-site-studio plugin, remove it from your codebase by running the following command:
composer remove acquia/blt-site-studio
Remove the following lines from the blt/blt.yml file:
site-studio:
rebuild: true
package-import: true
cohesion-import: true
If you do not leverage the blt-site-studio plugin but use custom scripts instead, ensure that you remove such references from your codebase.
Add the Site Studio Configuration Management module to your codebase by running the following command:
composer require drupal/sitestudio_config_management
Enable the module by running the following command:
./vendor/bin/drush en sitestudio_config_management -y
(Optional) Add the following lines to the settings.php file:
$settings['config_sync_directory'] = '../config/default/sync';
$settings['site_studio_sync'] = '../config/default/site_studio';
settings.php file already includes the paths for the config_sync_directory and site_studio_sync parameters, you can skip this step.settings.php file. For more information, see Using the Drupal Recommended Settings plugin.Verify the configuration import and export commands by running the following commands:
./vendor/bin/drush cex
./vendor/bin/drush cim
These commands must automatically export or import Site Studio configurations along with Drupal configurations based on the paths specified in your settings.php file.
Currently, the starter kit wizard uses drush site:install and drops the database of any existing site. Therefore, you cannot use starter kits after installation.
After you install Drupal Starter Kits, you can develop your Drupal site and deploy your changes to Cloud Next.
This starter kit installs Drupal Starter Kits to your Drupal site. An optional add-on content model is available during the installation process. For more information, see Community starter kit.
To install Drupal Starter Kits through the Community starter kit:
Access your Drupal project and run the following command:
./vendor/bin/acms acms:install
Existing users who want to prevent rebuilding Composer dependencies repeatedly can leverage separate build and install commands. For more information, see Using separate build and install commands.
In Please choose bundle from one of the above use case, select acquia_cms_community and press Enter.
For selection, you can use the Up and Down arrow keys.
In Do you want to enable the content model?, type yes or no and press Enter.
This question includes all content types in the site.
In Please provide the Google Maps API Key, type the Google Maps API key and press Enter.
The starter kit wizard does not prompt for the key if you have already configured the environment variable with the export GMAPS_KEY="<your_key>" command. Also, you can skip this step if you do not have the key.
Specify the database information, such as name, driver, username, password, host, and port.
To prevent failed installation, ensure that you:
Currently, the starter kit wizard uses drush site:install and drops the database of any existing site. Therefore, you cannot use starter kits after installation.
After you install Drupal Starter Kits, you can develop your Drupal site and deploy your changes to Cloud Next.
This starter kit preconfigures Drupal for serving structured, RESTful content to third-party content displays, such as mobile apps, smart displays, and frontend driven websites. For more information, see Headless starter kit.
To install Drupal Starter Kits through the Headless starter kit:
Access your Drupal project and run the following command:
./vendor/bin/acms acms:install
Existing users who want to prevent rebuilding Composer dependencies repeatedly can leverage separate build and install commands. For more information, see Using separate build and install commands.
In Please choose bundle from one of the above use case, select acquia_cms_headless and press Enter.
For selection, you can use the Up and Down arrow keys.
In Do you want to enable the content model?, type yes or no and press Enter.
This question includes all content types in the site.
In Please provide the Google Maps API Key, type the Google Maps API key and press Enter.
The starter kit wizard does not prompt for the key if you have already configured the environment variable with the export GMAPS_KEY="<your_key>" command. Also, you can skip this step if you do not have the key.
Specify the database information, such as name, driver, username, password, host, and port.
To prevent failed installation, ensure that you:
Currently, the starter kit wizard uses drush site:install and drops the database of any existing site. Therefore, you cannot use starter kits after installation.
After you install Drupal Starter Kits, you can develop your Drupal site and deploy your changes to Cloud Next.
If this content did not answer your questions, try searching or contacting our support team for further assistance.
Drupal Starter Kits