Skip to content

Latest commit

 

History

History
50 lines (32 loc) · 2.47 KB

README.md

File metadata and controls

50 lines (32 loc) · 2.47 KB
Raw

Shopify App Template - None (app with extensions only)

This is a template for building a Shopify app that includes no app home UI. It contains the basics for building a Shopify app that uses only app extensions.

If you plan for your app to load its own page in the Shopify Admin, then you'll want to choose one of our other templates.

Whether you choose to use this template or another one, you can use your preferred package manager and the Shopify CLI with these steps.

Benefits

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 respository.

Getting started

Requirements

  1. You must download and install Node.js if you don't already have it.
  2. You must install pnpm if you don't already have it.
  3. You must create a Shopify partner account if you don’t have one.
  4. You must create a store for testing if you don't have one, either a development store or a Shopify Plus sandbox store.

Setup

Make sure to install the dependencies.

pnpm install

Local Development

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.

cd extensions/theme-extension
# you can use the notify flag to enable live reloading
pnpm run dev --notify /tmp/extension.update

Open the URL generated in your console. Once you grant permission to the app, you can start development (such as generating extensions).

Developer resources