This is a Docksal-based for the FiveJars Booster Drupal distribution.

Docksal is used as a local development environment.

Sponsored and developed by Five Jars.

Get Started

You need to install Docksal on your local machine according to Docksal setup instructions.

Full install from scratch

Note: a local instance of PHP and/or Composer is not required.

Follow these steps to get fully prepared project.

Install Docksal

curl -fsSL https://get.docksal.io | bash

Clone Booster distribution Docksal project

git clone [email protected]:fivejars/booster_drupal_docksal.git booster

Add your custom settings

• Copy example.docksal-local.env file to docksal-local.env file inside .docksal directory.

• Use PROJECT_VERSION to specify the branch of the fivejars/booster_drupal_project to be used as a composer project. In the most cases you'll need:

  • 1.x for a latest development version.

• Use DISTRIBUTION_VERSION to specify the branch of the fivejars/booster_drupal will be checkout automatically. Take in mind, the version corresponds the one, required in a root composer.json. Use 1.x to start the development from the latest distribution progress.

• During an execution of a build_project command, all the directories except an ignored ones would be deleted. If you work on the existing project and want to save any folder in a project root directory - add folder name to IGNORE_CUSTOM. Directories names should be separated with spaces.

Build Booster distribution project

Run this command inside your project directory:

fin build_project

As a result you will get full Booster Website installation in your file system.

The "Killed" message during command run usually means that you need to increase memory limits in your Docksal. For macOS or Windows overall memory volume available for Docker is limited by the virtual machine or Docker Desktop settings.

Build Booster distribution Demo project

It is built in the same way as the distribution project, but requires a different example file in the Add your custom settings step. If you need to build the Booster Demo project, please use example-demo.docksal-local.env.

Install Booster distribution website

After fin build_project command finish you need to install a site. For this you can use fin init command.

Start the project

fin init

The webserver starts up, and the site will be installed automatically with drush si.