From d486c497045b2e88692314845175bccc4616dcd6 Mon Sep 17 00:00:00 2001
From: Erik Christensen <32500994+christensenep@users.noreply.github.com>
Date: Wed, 13 Mar 2024 14:25:40 -0700
Subject: [PATCH] chore(core): Update core .env.example (#651)

---
 apps/core/.env.example | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)

diff --git a/apps/core/.env.example b/apps/core/.env.example
index 22e5cff1b1..b0425c7015 100644
--- a/apps/core/.env.example
+++ b/apps/core/.env.example
@@ -1,4 +1,36 @@
+# The hash visible in the subject store's URL when signed in to the store control panel.
+# The control panel URL is of the form `https://store-{hash}.mybigcommerce.com`. 
 BIGCOMMERCE_STORE_HASH=
+
+# The access token from a store-level API account. The only scope required to run Catalyst is Carts `manage`.
+# See https://developer.bigcommerce.com/docs/start/authentication/api-accounts#store-level-api-accounts
 BIGCOMMERCE_ACCESS_TOKEN=
+
+# A bearer token that authorizes server-to-server requests to the GraphQL Storefront API
+# See https://developer.bigcommerce.com/docs/rest-authentication/tokens/customer-impersonation-token
 BIGCOMMERCE_CUSTOMER_IMPERSONATION_TOKEN=
+
+# The Channel ID for the selling channel being serviced by this Catalyst storefront.
+# Channel ID 1 will allow you to load the same data being used on the default Stencil storefront on your store,
+# but it is strongly recommended to create a new channel instead for production. 
+# The CLI can do this for you.
 BIGCOMMERCE_CHANNEL_ID=1
+
+# Set to true to allow the /admin route to redirect to the BigCommerce control panel.
+# `false` is recommended for production. Defaults to false when not specified.
+# You may also delete /admin/route.ts if you wish.
+ENABLE_ADMIN_ROUTE=true
+
+# Used by Auth.js, formerly NextAuth. To generate, run `openssl rand -hex 32` in your terminal.
+AUTH_SECRET=
+
+# Recommended so that you can use Turborepo's Remote Cache feature with signed artifacts
+# https://turbo.build/repo/docs/core-concepts/remote-caching#artifact-integrity-and-authenticity-verification
+# This can also be generated with `openssl rand -hex 32`, but do not re-use the value from AUTH_SECRET
+TURBO_REMOTE_CACHE_SIGNATURE_KEY=
+
+# NextJS will persists cached queries in Data Cache
+# The time persisted is not defined
+# https://nextjs.org/docs/app/building-your-application/caching#data-cache
+# This sets a sensible revalidation target for cached requests
+NEXT_PUBLIC_DEFAULT_REVALIDATE_TARGET=3600