Adobe Commerce checkout starter kit

Welcome to the home of Adobe Commerce checkout starter kit.

This starter kit is designed to help you get started with building custom checkout experiences for Adobe Commerce. Its goal is to showcase how to use Adobe Commerce Extensibility in combination with Adobe App Builder to build custom checkout experiences.

For more details, please refer to the Adobe Commerce checkout starter kit documentation.

Apps in this repo

The starter kit is split into independent Adobe Commerce App Management apps, one per checkout domain, so each can be installed, associated, and versioned on its own. See the App Management docs for install, build/deploy, and association details common to all of them.

App	What it does	Docs
apps/shipping-method	Out-of-process shipping method scaffolding.	Shipping in Checkout Starter Kit
apps/payment-method	Out-of-process payment method scaffolding.	Payment in Checkout Starter Kit
apps/tax-integration	Out-of-process tax integration scaffolding.	Tax in Checkout Starter Kit
apps/totals-collector	Out-of-process totals collector scaffolding.	Totals Collector in Checkout Starter Kit

Quick setup

Use aio app init <dir> --repo adobe/commerce-checkout-starter-kit/apps/<app-name> to scaffold a new project from one of the apps in this repo:

aio app init my-shipping-method --repo adobe/commerce-checkout-starter-kit/apps/shipping-method
aio app init my-payment-method --repo adobe/commerce-checkout-starter-kit/apps/payment-method
aio app init my-tax-integration --repo adobe/commerce-checkout-starter-kit/apps/tax-integration
aio app init my-totals-collector --repo adobe/commerce-checkout-starter-kit/apps/totals-collector

App submission guidelines

Submitting your own Adobe Commerce app for review? Adobe's App submission guidelines recommend using this starter kit's documentation as a starting point. See SUBMISSION_TEMPLATE.md for an example installation guide that follows those guidelines.

Contributing

See .github/CONTRIBUTING.md for how to contribute, and .github/MAINTAINERS.md for how the apps/* CI/CD pipeline works and how to onboard a new app to it.