Installation

Installation methods used by Koru Suite apps.

Koru Suite apps use one of the following installation methods. Each app page only shows the method or methods that it actually supports.

Installation methods

VTEX Admin App through the CLI

Install it in a VTEX account and workspace with the official VTEX CLI:

vtex install {account}.app-name@0.x

You then open and configure it from VTEX Admin. It is not added to the Store Theme.

VTEX Storefront App

Add it as a dependency of a VTEX IO Store Theme and declare its block in the template where it should render.

Widget through a <script>

Add an integration snippet to the website HTML. This method is platform-independent.

Google Tag Manager

Load the script as a Custom HTML tag and trigger it on the pages where the widget should appear.

Not sure which method to use?

Do not choose a method by approximation. Follow the app's Installation section: it lists only the supported variants and their verification steps.