Skip to content

Commit

Permalink
Add dev preview warning
Browse files Browse the repository at this point in the history
  • Loading branch information
blittle committed Jul 25, 2023
1 parent b666388 commit 35cba29
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion examples/customer-api/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Hydrogen Customer API Example

**Caution: The Customer API and this example are both in an unstable pre-release state and may have breaking changes in a future release.**

This is an example using the new Shopify [Customer Accounts API](https://shopify.dev/docs/api/customer). Note this functionality is in dev preview, the API is subject to change, and should not be used in production.

## Requirements
Expand All @@ -14,7 +16,7 @@ This is an example using the new Shopify [Customer Accounts API](https://shopify
1. Copy the permanent domain from ngrok and add a callback URI: `https://your-ngrok-domain.app/authorize`
1. Add a JavaScript origin with your ngrok domain: `https://your-ngrok-domain.app`
1. Add a logout URI to your ngrok domain: `https://your-ngrok-domain.app`
1. Copy `.env.example` to `.env` and replace the credentials with those from your Hydrogen channel.
1. Copy `env.example` to `.env` and replace the credentials with those from your Hydrogen channel.
1. Update the `ngrok` script within `package.json` to use your ngrok domain
1. In a terminal start ngrok with `npm run ngrok`
1. In another terminal, start hydrogen with `npm run dev`

0 comments on commit 35cba29

Please sign in to comment.