docs: add comments to .env.example explaining how to get Shopify env …#1519
Open
jitheng wants to merge 1 commit into
Open
docs: add comments to .env.example explaining how to get Shopify env …#1519jitheng wants to merge 1 commit into
jitheng wants to merge 1 commit into
Conversation
…vars Fixes vercel#1517 - Users were confused about where to obtain the Shopify environment variables. Added inline comments to .env.example explaining step-by-step how to get SHOPIFY_STOREFRONT_ACCESS_TOKEN (from Shopify app API credentials), SHOPIFY_REVALIDATION_SECRET (a self-chosen secret for webhook auth), and SHOPIFY_STORE_DOMAIN.
Contributor
|
@jitheng is attempting to deploy a commit to the Vercel Solutions Team on Vercel. A member of the Team first needs to authorize it. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes #1517
Users were confused about where to obtain the required Shopify environment variables (
SHOPIFY_STOREFRONT_ACCESS_TOKEN,SHOPIFY_REVALIDATION_SECRET,SHOPIFY_STORE_DOMAIN) when setting up Next.js Commerce.Changes
Added inline comments to
.env.examplewith step-by-step instructions explaining:SHOPIFY_STOREFRONT_ACCESS_TOKEN: How to navigate to Shopify Admin → Apps → Develop apps, create/configure an app with Storefront API scopes, and copy the access token from API credentials.SHOPIFY_REVALIDATION_SECRET: That this is a self-chosen secret string (not from Shopify's app credentials), and how to generate one and configure Shopify webhooks to use it.SHOPIFY_STORE_DOMAIN: How to find the store's.myshopify.comsubdomain.Motivation
The original
.env.examplehad empty values with no guidance, causing confusion for new contributors (ref: issue #1517). TheSHOPIFY_REVALIDATION_SECRETin particular is easy to confuse with Shopify's app "client secret" — this PR clarifies that it is a user-generated value used to authenticate webhook requests.