Centralize sample storefront configuration

Author: kyle-schellen

.env.example

@@ -0,0 +1,33 @@
+# Checkout Kit sample storefront configuration.
+# Copy this file to .env, fill in local values, then run:
+# scripts/setup_storefront_env
+# Optional Apple Pay and Customer Account API values can stay blank.
+#
+# Do not commit real values from .env or generated platform config files.
+
+# Storefront details
+STOREFRONT_DOMAIN=your-store.myshopify.com
+STOREFRONT_ACCESS_TOKEN=your-public-storefront-access-token
+# Optional Apple Pay merchant identifier used by accelerated checkout flows.
+STOREFRONT_MERCHANT_IDENTIFIER=
+
+# Storefront API version
+API_VERSION=2026-04
+
+# Customer Account API (optional)
+CUSTOMER_ACCOUNT_API_CLIENT_ID=
+CUSTOMER_ACCOUNT_API_SHOP_ID=
+CUSTOMER_ACCOUNT_API_VERSION=2026-04
+
+# Buyer identity defaults used by sample apps
+EMAIL=checkout-kit@example.com
+ADDRESS_1=650 King Street
+ADDRESS_2=Shopify HQ
+CITY=Toronto
+COMPANY=Shopify
+COUNTRY=CA
+FIRST_NAME=Evelyn
+LAST_NAME=Hartley
+PROVINCE=ON
+ZIP=M5V 1M7
+PHONE=+14165550100

.github/CONTRIBUTING.md

@@ -50,6 +50,11 @@ dev check
 
 Platform-scoped commands are available as `dev android <command>`, `dev swift <command>`, and `dev react-native <command>` (or `dev rn`). Protocol schema/model commands are available as `dev protocol <command>`. For cross-platform changes, use `dev lint`, `dev test`, `dev check`, `dev format`, and `dev build`.
 
+Sample app storefront configuration is generated from the repo-root `.env`.
+Shopify employees get this through `dev up`. External contributors can copy
+`.env.example` to `.env`, fill in local storefront values, then run
+`scripts/setup_storefront_env` from the repo root.
+
 ---
 
 ## Swift (`platforms/swift/`)

.github/workflows/android-test.yml

@@ -47,8 +47,10 @@ jobs:
           cache: 'gradle'
 
       - name: Setup sample app environment
-        run: cp .env.example .env
-        working-directory: platforms/android/samples/MobileBuyIntegration
+        run: ${{ github.workspace }}/scripts/setup_storefront_env --skip-optional-prompts
+        env:
+          STOREFRONT_DOMAIN: example.myshopify.com
+          STOREFRONT_ACCESS_TOKEN: test-token
 
       - name: Build Sample App
         run: ./gradlew assembleDebug

.github/workflows/rn-test-android.yml

@@ -54,10 +54,12 @@ jobs:
         env:
           GRADLE_OPTS: -Xmx4g -XX:MaxMetaspaceSize=768m
           JAVA_HOME: ${{ steps.setup-java.outputs.path }}
+          STOREFRONT_DOMAIN: example.myshopify.com
+          STOREFRONT_ACCESS_TOKEN: test-token
         run: |
           echo "JAVA_HOME: $JAVA_HOME"
           java -version
           javac -version
-          echo "STOREFRONT_DOMAIN=myshopify.com" > sample/.env
+          ${{ github.workspace }}/scripts/setup_storefront_env --skip-optional-prompts
           pnpm module build
           pnpm sample test:android --no-daemon

.github/workflows/swift-build-samples.yml

@@ -13,3 +13,4 @@ jobs:
     with:
       test-path: ./Scripts/build_samples
       job-name: Build Sample Apps
+      setup-storefront-env: true

.github/workflows/swift-test-workflow.yml

@@ -8,6 +8,10 @@ on:
         required: false
         type: string
         default: Run
+      setup-storefront-env:
+        required: false
+        type: boolean
+        default: false
 
 permissions:
   contents: read
@@ -68,5 +72,12 @@ jobs:
           echo "CURRENT_SIMULATOR_UUID=$CURRENT_SIMULATOR_UUID" >> $GITHUB_ENV
           echo ""
 
+      - name: Setup sample app storefront configuration
+        if: ${{ inputs.setup-storefront-env }}
+        env:
+          STOREFRONT_DOMAIN: example.myshopify.com
+          STOREFRONT_ACCESS_TOKEN: test-token
+        run: ${{ github.workspace }}/scripts/setup_storefront_env --skip-optional-prompts
+
       - name: Run Tests
         run: ${{ inputs.test-path }}

platforms/android/samples/MobileBuyIntegration/.env.example

@@ -66,13 +66,14 @@ Do not edit files in `app/build/generated/source/apollo/` by hand. Update `.grap
 
 ## Setup
 
-From this directory:
+From the repo root:
 
 ```sh
 cp .env.example .env
+scripts/setup_storefront_env
 ```
 
-Edit `.env`:
+Edit the repo-root `.env`:
 
 ```text
 STOREFRONT_DOMAIN=your-store.myshopify.com
@@ -84,19 +85,21 @@ Optional values enable Customer Account API and buyer identity demo flows:
 
 ```text
 CUSTOMER_ACCOUNT_API_CLIENT_ID=your-client-id
-CUSTOMER_ACCOUNT_API_REDIRECT_URI=shop.<shop id>.app://callback
-CUSTOMER_ACCOUNT_API_GRAPHQL_BASE_URL=https://shopify.com/<shop id>/account/customer/api/<api version>/graphql
-CUSTOMER_ACCOUNT_API_AUTH_BASE_URL=https://shopify.com/authentication/<shop id>
-PREFILL_EMAIL=test.buyer@example.com
-PREFILL_PHONE=+16135550123
+CUSTOMER_ACCOUNT_API_SHOP_ID=your-shop-id
+CUSTOMER_ACCOUNT_API_VERSION=2026-04
+EMAIL=test.buyer@example.com
+PHONE=+16135550123
 ```
 
+The setup script generates this sample's local `.env`.
+
 Open the project in Android Studio, sync Gradle, then build and run.
 
 ## Updating the Storefront API version
 
-1. Update `API_VERSION` in `.env`.
-2. Download the schema with Rover. This introspects your store's Storefront API and writes `schema.graphqls` into `app/src/main/graphql/`.
+1. Update `API_VERSION` in the repo-root `.env`.
+2. Run `scripts/setup_storefront_env` from the repo root.
+3. Download the schema with Rover. This introspects your store's Storefront API and writes `schema.graphqls` into `app/src/main/graphql/`.
 
    ```sh
    rover graph introspect \
@@ -105,7 +108,7 @@ Open the project in Android Studio, sync Gradle, then build and run.
      --output "app/src/main/graphql/schema.graphqls"
    ```
 
-3. Update GraphQL operations in `app/src/main/graphql/` if the schema changed. For example, add a product field to `FetchProducts.graphql` before regenerating types:
+4. Update GraphQL operations in `app/src/main/graphql/` if the schema changed. For example, add a product field to `FetchProducts.graphql` before regenerating types:
 
    ```graphql
    query FetchProducts(...) {

platforms/android/samples/MobileBuyIntegration/README.md

@@ -20,21 +20,40 @@ def loadProperties() {
 
 def properties = loadProperties()
 
+def propertyOrDefault = { String key, String defaultValue ->
+    def value = properties.getProperty(key)
+    return value?.trim() ? value.trim() : defaultValue
+}
+
 // Storefront API
 def storefrontDomain = properties.getProperty("STOREFRONT_DOMAIN")
 def accessToken = properties.getProperty("STOREFRONT_ACCESS_TOKEN")
 def apiVersion = properties.getProperty("API_VERSION", "2026-04")
 
 // Customer Account API
 def customerAccountApiClientId = properties.getProperty("CUSTOMER_ACCOUNT_API_CLIENT_ID")
+def customerAccountApiShopId = properties.getProperty("CUSTOMER_ACCOUNT_API_SHOP_ID")
+def customerAccountApiVersion = propertyOrDefault("CUSTOMER_ACCOUNT_API_VERSION", "unstable")
 def customerAccountApiRedirectUri = properties.getProperty("CUSTOMER_ACCOUNT_API_REDIRECT_URI")
 
 def customerAccountApiGraphQLBaseUrl = properties.getProperty("CUSTOMER_ACCOUNT_API_GRAPHQL_BASE_URL")
 def customerAccountApiAuthBaseUrl = properties.getProperty("CUSTOMER_ACCOUNT_API_AUTH_BASE_URL")
 
+if (!customerAccountApiRedirectUri && customerAccountApiShopId) {
+    customerAccountApiRedirectUri = "shop.${customerAccountApiShopId}.app://callback"
+}
+
+if (!customerAccountApiGraphQLBaseUrl && customerAccountApiShopId) {
+    customerAccountApiGraphQLBaseUrl = "https://shopify.com/${customerAccountApiShopId}/account/customer/api/${customerAccountApiVersion}/graphql"
+}
+
+if (!customerAccountApiAuthBaseUrl && customerAccountApiShopId) {
+    customerAccountApiAuthBaseUrl = "https://shopify.com/authentication/${customerAccountApiShopId}"
+}
+
 // Demo buyer identity (prefill toggle in Settings)
-def prefillEmail = properties.getProperty("PREFILL_EMAIL", "test.buyer@example.com")
-def prefillPhone = properties.getProperty("PREFILL_PHONE", "+16135550123")
+def prefillEmail = properties.getProperty("EMAIL", properties.getProperty("PREFILL_EMAIL", "test.buyer@example.com"))
+def prefillPhone = properties.getProperty("PHONE", properties.getProperty("PREFILL_PHONE", "+14165550100"))
 
 if (!storefrontDomain || !accessToken) {
     println("**** Please add a .env file with STOREFRONT_DOMAIN and STOREFRONT_ACCESS_TOKEN set *****")

platforms/android/samples/MobileBuyIntegration/app/build.gradle

@@ -8,18 +8,21 @@ This directory contains Android sample apps for Checkout Kit.
 
 ## Setup
 
-From `platforms/android/samples/MobileBuyIntegration`:
+From the repo root:
 
 ```sh
 cp .env.example .env
+scripts/setup_storefront_env
 ```
 
-Fill in:
+Fill `.env` with:
 
 - `STOREFRONT_DOMAIN`
 - `STOREFRONT_ACCESS_TOKEN`
 - `API_VERSION`
 - Optional Customer Account API values
 - Optional demo buyer identity values
 
+The setup script generates `platforms/android/samples/MobileBuyIntegration/.env`.
+
 Open `MobileBuyIntegration` in Android Studio, sync Gradle, then build and run the `app` target.