Skip to content

Commit

Permalink
feat(readme): updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
oybek-daniyarov committed Apr 1, 2024
1 parent 4d28219 commit 482d2a0
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 0 deletions.
1 change: 1 addition & 0 deletions .env.example
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ SITE_NAME="Next.js Commerce"
SHOPIFY_REVALIDATION_SECRET=""
SHOPIFY_STOREFRONT_ACCESS_TOKEN=""
SHOPIFY_STORE_DOMAIN="[your-shopify-store-subdomain].myshopify.com"
NEXT_PUBLIC_SHOPIFY_SHOP_ID="[your-shopify-shop-id]"
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ A Next.js 14 and App Router-ready ecommerce template featuring:
- Styling with Tailwind CSS
- Checkout and payments with Shopify
- Automatic light/dark mode based on system settings
- Shopify Analytics

<h3 id="v1-note"></h3>

Expand Down Expand Up @@ -51,6 +52,21 @@ Integrations enable upgraded or additional functionality for Next.js Commerce
configuration.
- Search runs entirely in the browser for smaller catalogs or on a CDN for larger.

## Shopify analytics

1. Visit https://[your-store-id].myshopify.com/shop.json
2. Search for `shopId` and add it to the `NEXT_PUBLIC_SHOPIFY_SHOP_ID` in your `.env` file.

To test out Shopify analytics, in your localhost, you can use the following steps:

1. Install ngrok
2. Setup custom domain in ngrok dashboard
3. Expose your local development server (e.g., running on port 3000) with a command:

```bash
ngrok http --domain=YOUR_NGROK_DOMAIN 3000
```

## Running locally

You will need to use the environment variables [defined in `.env.example`](.env.example) to run Next.js Commerce. It's
Expand Down

0 comments on commit 482d2a0

Please sign in to comment.