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.5or higher. -
Node.js version 24. If you have Node Version Manager (
nvm) installed, you can run the following command to install and use the required version:nvm install 24 && nvm use -
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.0and higher), you must also complete the Admin UI SDK installation process.
data-variant=help
data-slots=text1, text2
composer require "magento/commerce-backend-sdk": ">=3.0"
Initialize your app
Each checkout domain (payment, shipping, tax, totals collector) is an independent app. Initialize the one you need using one of the following approaches:
-
To start from this starter kit's app as a template, run the following command, where
<dir>is the name of the project directory to create:aio app init <dir> --repo adobe/commerce-checkout-starter-kit/apps/<app> --github-pat $GITHUB_PATReplace
<app>with the domain you want to install (shipping-method,payment-method,tax-integration, ortotals-collector), and$GITHUB_PATwith your GitHub personal access token. For more information, refer to managing your personal access tokens.This creates an Adobe Developer Console project (or lets you select an existing one), but does not add the services the app needs. Add them manually in the Adobe Developer Console, or run:
aio app add serviceThen select the services required for your app, such as I/O Management API and Adobe Commerce as a Cloud Service.
-
To build your own App Management app from scratch instead, refer to Initialize your app.
After completing these steps you can:
Install Commerce modules
data-src=/_includes/checkout-version.md
Install the individual modules
To install the individual modules, refer to the following topics: