LeonelAimar / new-shopify-node-ts-app-boilerplate

Shopify boilerplate for embedded apps. Built and re-written from the official Shopify CLI's app boilerplate, but moved it to Typescript, and some modular improvements, so you can use any frontend framework you want. I left it comes by default, with React.

Shopify App Node

This is a sample app to help developers bootstrap their Shopify app development.

It leverages the Shopify API Library on the backend to create an embedded app, and Polaris and App Bridge React on the frontend.

This is the repository used when you create a new Node app with the Shopify CLI.

Requirements

• If you don’t have one, create a Shopify partner account.
• If you don’t have one, create a Development store where you can install and test your app.
• If you are not using the Shopify CLI, in the Partner dashboard, create a new app. You’ll need this app’s API credentials during the setup process.

Installation

Using the Shopify CLI run:

shopify app create node -n APP_NAME

Or, you can run npx degit shopify/shopify-app-node and create a .env file containing the following values:

SHOPIFY_API_KEY={api key}           # Your API key
SHOPIFY_API_SECRET={api secret key} # Your API secret key
SCOPES={scopes}                     # Your app's required scopes, comma-separated
HOST={your app's host}              # Your app's host, without the protocol prefix

Developer resources

• Introduction to Shopify apps
  • App authentication
• Shopify CLI command reference
• Shopify API Library documentation

License

This repository is available as open source under the terms of the MIT License.