@shopify/admin-ui-extensions-run

Admin UI Extensions Run

The Admin UI Extensions Run allows you to build and preview Admin UI Extensions. This tool is intended to help partners test Admin UI Extensions before publishing to Shopify. It comes packaged with Shopify CLI, so when you create an extension using Shopify CLI's shopify create extension command, your project will automatically consume this package.

Start using this tool in one of two ways:

1. Create an extension with Shopify CLI
   Shopify CLI clones admin-ui-extensions-template repo, which consumes this package to build and serve Admin UI Extensions it generates
2. Manually clone the admin-ui-extensions-template
   Bypass Shopify CLI and follow the set up steps in the README from admin-ui-extensions-template

How to use

When consumed in a project, the command admin-ui-extensions-run becomes available to the project. The command can be used to build and serve Admin UI Extensions.

To use this package in an UI Extension project, run:

npm install @shopify/admin-ui-extensions-run

or

yarn add @shopify/admin-ui-extensions-run

See usage details in the API docs.

Local development of this tool

To make and preview changes from ./src, run a local server from this project using:

yarn server