Skip to content

Commit 8c0875d

Browse files
committed
Update read me and add example env variables
1 parent 7b25b59 commit 8c0875d

File tree

2 files changed

+16
-5
lines changed

2 files changed

+16
-5
lines changed

.env.example

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
COMPANY_NAME="Your company"
2+
TWITTER_CREATOR="@your company"
3+
TWITTER_SITE="Your site"
4+
SITE_NAME="your site name"
5+
SHOPIFY_REVALIDATION_SECRET="XXXXXXXXXXXXXXXXX"
6+
SHOPIFY_STOREFRONT_ACCESS_TOKEN="XXXXXXXXXXXXXXXXX"
7+
SHOPIFY_STORE_DOMAIN="YOUR_SHOP.myshopify.com"
8+
9+
FEATURED_PRODUCT_SLUG="special-cakes"
10+
MAIN_MENU_NAME="main-menu"

README.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
# Next.js + Headless Shopify E-Commerce Template
1+
# [Next.js + Headless Shopify E-Commerce Template](https://panini-cake.vercel.app/)
22

33
This is a Next.Js + Typescript + Tailwindcss + headless Shopify free starter template.
44
This project is based on [Next.js Commerce starter template](https://github.com/vercel/commerce).
5+
56
The live project can be found at [https://panini-cake.vercel.app/](https://panini-cake.vercel.app/)
67

78
![Hero Image](/public/template/screenshot.png?raw=true 'Panini Cake Shop hero')
@@ -46,7 +47,7 @@ FEATURED_PRODUCT_SLUG="special-cakes"
4647
MAIN_MENU_NAME="main-menu"
4748
```
4849

49-
Got to the [Shopify Partner website](https://www.shopify.com/uk/partners) and create a free account, you will then be able to create a free development store. If you never used Shopify, please familiarize a bit with the admin dashboard.
50+
Got to the [Shopify Partner website](https://www.shopify.com/uk/partners) and create a free account, you will then be able to create a free development store.
5051

5152
Once you are done, go to settings and find the apps section, then head to the [Shopify app store](https://apps.shopify.com/) and install the Headless app.
5253

@@ -57,7 +58,7 @@ SHOPIFY_REVALIDATION_SECRET="XXXXXXXXXXXXXXXXX"
5758
SHOPIFY_STOREFRONT_ACCESS_TOKEN="XXXXXXXXXXXXXXXXX"
5859
```
5960

60-
Once replaced you can run
61+
Once replaced, you can run
6162

6263
```bash
6364
npm run dev
@@ -71,11 +72,11 @@ For the featured products you will need to create new entries under your product
7172

7273
The current menu name is main-menu, but you can give any name in your Shopify admin and change the .env variable accordingly.
7374

74-
### Metafields
75+
## Metafields
7576

7677
This template also supports custom fields if you wish to add your own extra sections for pages and products, directly editable from your Shopify dashboard.
7778

7879
Go to the [Shopify app store](https://apps.shopify.com/) and add ACF: Metafields Custom Fields. Familiarize yourself with it a bit.
7980

8081
Once you are done start creating your custom metafields.
81-
Curently this theme supports metafileds on the about and contacts pages, you can specify what you want to retrieve in the metafields array inside those pages.
82+
Currently this theme supports metafileds on the about and contacts pages, you can specify what you want to retrieve in the metafields array inside those pages.

0 commit comments

Comments
 (0)