This is a template for building an extension-only Shopify app. It contains the basics for building a Shopify app that uses only app extensions.
This template doesn't include a server or the ability to embed a page in the Shopify Admin. If you want either of these capabilities, choose the Remix app template instead.
Whether you choose to use this template or another one, you can use your preferred package manager and the Shopify CLI with these steps.
Shopify apps are built on a variety of Shopify tools to create a great merchant experience. The create an app tutorial in our developer documentation will guide you through creating a Shopify app.
This app template does little more than install the CLI and scaffold a repository.
- You must download and install Node.js if you don't already have it.
- You must create a Shopify partner account if you don’t have one.
- You must create a store for testing if you don't have one, either a development store or a Shopify Plus sandbox store.
This template can be installed using your preferred package manager:
Using yarn:
yarn create @shopify/app
Using npm:
npm init @shopify/app@latest
Using pnpm:
pnpm create @shopify/app@latest
This will clone the template and install the required dependencies.
The Shopify CLI connects to an app in your Partners dashboard. It provides environment variables and runs commands in parallel.
You can develop locally using your preferred package manager. Run one of the following commands from the root of your app.
Using yarn:
yarn dev
Using npm:
npm run dev
Using pnpm:
pnpm run dev
Open the URL generated in your console. Once you grant permission to the app, you can start development (such as generating extensions).