Install Page Builder

For everyone else, Page Builder is automatically installed with Adobe Commerce 2.3.1. There is nothing else you need to do.

GitHub installation for Contributors

Before installing Page Builder for making contributions, you must have the following prerequisites:

• A local development installation of Adobe Commerce 2.3.1+ -- Use the installation instructions from the DevDocs installation guide.

• Access to the private Page Builder repository. You should participate in Adobe Partner Program to have these permissions.

• npm package manager

1. Clone the Page Builder repos into the root directory of your Adobe Commerce 2.3+ installation:

   Copy
   git clone https://github.com/magento/magento2-page-builder
   git clone https://github.com/magento/magento2-page-builder-ee
   Copied to your clipboard
   git clone https://github.com/magento/magento2-page-builder
   git clone https://github.com/magento/magento2-page-builder-ee

2. From the root directory of your Adobe Commerce installation, use the dev/tools/build-ee.php script to symlink magento2-page-builder and magento2-page-builder-ee repos into your Magento Commerce installation:

   Copy
   php dev/tools/build-ee.php --command=link --exclude=true --ee-source="magento2-page-builder" --ce-source="."
   php dev/tools/build-ee.php --command=link --exclude=true --ee-source="magento2-page-builder-ee" --ce-source="."
   Copied to your clipboard
   php dev/tools/build-ee.php --command=link --exclude=true --ee-source="magento2-page-builder" --ce-source="."
   php dev/tools/build-ee.php --command=link --exclude=true --ee-source="magento2-page-builder-ee" --ce-source="."

   The results should look like this:

   

3. Enable the Page Builder module using the following command:

   Copy
   bin/magento setup:upgrade
   Copied to your clipboard
   bin/magento setup:upgrade

Updating GitHub installation

When a new version of Page Builder is available, pull the latest versions from GitHub at magento/magento2-page-builder and magento/magento2-page-builder-ee.

Installing Node.js dependencies

If you plan to contribute to Page Builder, you need to install Node.js dependencies to compile TypeScript.

Navigate to the pagebuilder directory and install Page Builder dependencies using the following command:

Copy
cd <pagebuilder-git-folder>
npm install
Copied to your clipboard
cd <pagebuilder-git-folder>
npm install

After installing the npm packages, you can run:

Copy
npm run start
Copied to your clipboard
npm run start

This command watches for changes to your TypeScript files, compiles, and checks for errors.

Last updated 9/11/2023

Was this helpful?

Yes

No