argo-admin-template icon indicating copy to clipboard operation
argo-admin-template copied to clipboard

Template repository for App Extensions build with Shopify/shopify-app-cli

Shopify Admin, app extensions - Starter code

This repo contains starter code for apps that use Argo to extend the UI of the Shopify Admin.

For more about Argo and admin extensions, please read our docs.

Getting started

Use the Shopify App CLI to create your Argo-enabled extension.

Note: We do not recommend app developers to clone this repo directly. If you choose to do so, you will need to follow the instructions below to generate the starter code, and then set up the Shopify App CLI manually to use your extension.

Updating this repo

Shopify developers working on this repo will find most of the relevant code in the scripts/generate.

Start by cloning this repo:

git clone [email protected]:Shopify/argo-admin-template.git YOUR_EXTENSION_NAME

Then, generate the starter code:

cd YOUR_EXTENSION_NAME

# With npm
npm install
npm run generate -- --type=PRODUCT_SUBSCRIPTION

# With yarn
yarn
yarn generate --type=PRODUCT_SUBSCRIPTION

Note: Currently PRODUCT_SUBSCRIPTION and DEFAULT are the only supported extension types.

Finally, inspect the result of the generate command:

git diff