elasticpath / d2c-starter-kit

NextJS / React starter kit for D2C ecommerce
MIT License
4 stars 7 forks source link

Documentation section "Setup Local Environment" is incomplete #84

Open tgiesselmann-ep opened 1 year ago

tgiesselmann-ep commented 1 year ago

The readme states in the "Setup Local Environment" section:

Set at least the values marked \<required>

However, there is no explanation of what those values are or where to get them from. While some can be guessed, others such as the following require clarification:

Value Remark
REVALIDATE_SECRET_TOKEN What is a revalidate secret token? What is it used for? Where to get it?
NEXT_PUBLIC_COOKIE_PREFIX_KEY What is the cookie prefix used for? What value to use?
STRIPE_CLIENT_SECRET, NEXT_PUBLIC_STRIPE_KEY, NEXT_PUBLIC_STRIPE_ACCOUNT_ID, NEXT_PUBLIC_BRAINTREE_KEY • It says under "Cart and Checkout": "Currently supporting Braintree checkout (Elastic Path Payments coming soon)", yet there are instructions for setting up EP Payments with Stripe. Most likely the docs haven't been updated.
• If EP Payments is the default then NEXT_PUBLIC_BRAINTREE_KEY should not be listed as required.
• If both are available, how does one select one over the other?

Thank you! :-)

Stevie-Ray commented 1 year ago

It would also be nice if there was documentation about NEXT_PUBLIC_DEMO_PROMO_ID & NEXT_PUBLIC_DEMO_NODE_ID