From cef4acba5435972e5be7ac040b4070ad47e39a71 Mon Sep 17 00:00:00 2001 From: Surya Rajendhran <32726562+suryarajendhran@users.noreply.github.com> Date: Thu, 25 Jul 2024 15:13:58 +0530 Subject: [PATCH] Update README.md --- README.md | 80 ++++--------------------------------------------------- 1 file changed, 5 insertions(+), 75 deletions(-) diff --git a/README.md b/README.md index 14f300b..9bdfffb 100644 --- a/README.md +++ b/README.md @@ -1,78 +1,8 @@ -# Shopify App Template - None (app with extensions only) +# Testing Shopify Checkout UI Extensions -This is a template for building a [Shopify app](https://shopify.dev/docs/apps/getting-started) that includes no app home UI. It contains the basics for building a Shopify app that uses only app extensions. +This repository attempts to close the gap in documentation by Shopify on testing Checkout UI Extensions. You will find two extensions in this package: -**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.** +1. Checkout UI: This is a React Javascript extension +2. Checkout UI 2: This is a React Typescript extension -Whether you choose to use this template or another one, you can use your preferred package manager and the Shopify CLI with [these steps](#installing-the-template). - -## Benefits - -Shopify apps are built on a variety of Shopify tools to create a great merchant experience. The [create an app](https://shopify.dev/docs/apps/getting-started/create) 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](https://nodejs.org/en/download/) if you don't already have it. -1. You must [create a Shopify partner account](https://partners.shopify.com/signup) if you don’t have one. -1. You must create a store for testing if you don't have one, either a [development store](https://help.shopify.com/en/partners/dashboard/development-stores#create-a-development-store) or a [Shopify Plus sandbox store](https://help.shopify.com/en/partners/dashboard/managing-stores/plus-sandbox-store). - -### Installing the template - -This template can be installed using your preferred package manager: - -Using yarn: - -```shell -yarn create @shopify/app -``` - -Using npm: - -```shell -npm init @shopify/app@latest -``` - -Using pnpm: - -```shell -pnpm create @shopify/app@latest -``` - -This will clone the template and install the required dependencies. - -#### Local Development - -[The Shopify CLI](https://shopify.dev/docs/apps/tools/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: - -```shell -yarn dev -``` - -Using npm: - -```shell -npm run dev -``` - -Using pnpm: - -```shell -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). - -## Developer resources - -- [Introduction to Shopify apps](https://shopify.dev/docs/apps/getting-started) -- [App authentication](https://shopify.dev/docs/apps/auth) -- [Shopify CLI](https://shopify.dev/docs/apps/tools/cli) -- [Shopify API Library documentation](https://github.com/Shopify/shopify-api-js#readme) +And both extensions have tests that assert that the extension renders the welcome text.