README.md

commercetools UI Application Kit 💅

✨ Mono-repository with tools and components for developing Merchant Center customizations 🛠

To help you developing Merchant Center customizations, be sure to check out our ui-kit components library.

Getting started

If you are developing a Merchant Center Custom Application, follow the Custom Applications getting started guide.

If you are developing a Merchant Center Custom View, follow the Custom Views getting started guide.

Developing application-kit packages

Install the dependencies (uses pnpm workspaces):

$ pnpm install

To run the tests:

$ pnpm run test

# or
$ pnpm run test --watch

Build the application bundles

$ pnpm build

# or
$ pnpm build:watch

Start the playground application:

Note that the playground application consumes the app-kit dependencies ES modules, which means you need to bundle the packages first. We recommend to bundle the packages in watch mode in one terminal process and start the playground app in another terminal process.

// Terminal process 1
$ pnpm build:watch

// Terminal process 2
$ pnpm playground:start

Documentation

Please look at the single packages in packages folder for documentation specific of each package.

Contributing

Contributions are welcomed. Please have a read at our contribution guidelines.

Need Help?

In case you have any questions about or issues with the tools and components provided in this repository, please reach out to our Support team.