Getting started

To begin using the checkout starter kit, ensure that your Adobe Commerce installation meets the following prerequisites and then proceed with the installation and configuration.

Prerequisites

You must install or have access to the following prerequisites to develop with the Adobe Commerce checkout starter kit:

Adobe Commerce as a Cloud Service or Adobe Commerce version 2.4.5 or higher.

Node.js version 22. If you have Node Version Manager (nvm) installed, you can run the following command to install and use the required version:

nvm install 22 && nvm use
Copied to your clipboard
nvm install 22 && nvm use

Adobe I/O CLI.
Access to the Adobe Developer Console with an App Builder license. If you do not have access to the Adobe Developer Console or App Builder, refer to get access to App Builder.
If you intend to use the Admin UI SDK (version 3.0 and higher), you must also complete the Admin UI SDK installation process.

When completing the steps to install the Admin UI SDK, use the following command to get a version compatible with the checkout starter kit:

composer require "magento/commerce-backend-sdk": ">=3.0"
Copied to your clipboard
composer require "magento/commerce-backend-sdk": ">=3.0"

Initial configuration

Create an App Builder project

An App Builder project must be created before using the checkout starter kit.

Log in to the Adobe Developer Console and select the desired organization from the dropdown menu in the top-right corner.
Click Create new project from template.
NOTE: If the Create project from template option is not displayed, your request to access App Builder might not yet be approved.
Select App Builder. The Set up templated project page displays.
Specify a project title and app name. Mark the Include Runtime with each workspace checkbox. Optionally, you can create a custom workspace other than the default Stage workspace, by clicking Add Workspace, and entering a name and description. Click Save. The Console creates a project and workspaces.

Set up your local environment

Use the following steps to configure your local environment:

Create a folder for your project and navigate to it.

Execute the following command to create an Adobe Developer Console project in your organization and using the Commerce checkout starter kit as a template:

aio app init --repo adobe/commerce-checkout-starter-kit --github-pat $GITHUB_PAT
Copied to your clipboard
aio app init --repo adobe/commerce-checkout-starter-kit --github-pat $GITHUB_PAT

Replace $GITHUB_PAT with your GitHub personal access token. For more information, refer to managing your personal access tokens.

The starter kit requires you to add the following services in the console project:
- I/O Management API
- I/O Events
- Adobe I/O Events for Adobe Commerce
Execute the following command to add the services by selecting them from the list:
```
aio app add service
Copied to your clipboard
aio app add service
```
Copy the environment variables from the env.dist to a local .env file and enter the required values.

After completing the previous steps you can:

Install Commerce modules

Adobe Commerce as a Cloud Service is preconfigured with all the required modules for the checkout starter kit. Cloud Service users can proceed by configuring an App Builder project or configuring Commerce.

PaaS only

Before installing Commerce modules, ensure that you have the required credentials in auth.json with access to the Adobe Commerce repository.

Install the Payment, Shipping, or Tax modules

To install the individual modules, refer to the following topics:

Install the Commerce Eventing module (Commerce 2.4.5 only)

The Commerce Eventing module is crucial for handling events within Adobe Commerce. The eventing module is installed automatically in Adobe Commerce version 2.4.6 and higher.

This starter kit requires version 1.10.0 or higher of the Commerce Eventing module. To view your installed version, run the following command:

composer show magento/commerce-eventing
Copied to your clipboard
composer show magento/commerce-eventing

To install this module, run the following command using Composer:

composer update magento/commerce-eventing --with-dependencies
Copied to your clipboard
composer update magento/commerce-eventing --with-dependencies

For Adobe Commerce versions 2.4.5, you must install the Adobe I/O Events for Adobe Commerce module manually. Follow the instructions provided in Adobe I/O Events installation.

Use cases

Configure