From 3c9b7b03266571f6b88d2708badb02d0fd8edf8c Mon Sep 17 00:00:00 2001 From: Kathleen Tynan Maloney Date: Fri, 17 Nov 2023 10:21:42 -0700 Subject: [PATCH] Update README.md --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 96033d3..e2e930a 100644 --- a/README.md +++ b/README.md @@ -21,13 +21,26 @@ Best practices include: ## Setup +#### Requirements +Node and NPM setup: https://docs.npmjs.com/downloading-and-installing-node-js-and-npm + +* Node version: **v16 or greater** +* NPM version: **v8 or greater** + +[NVM](https://nodejs.org/en/download/package-manager#nvm) is a nifty tool to help toggle between enironment versions + + #### Install dependencies +Within the root of the project (~/storefront-product-listing-page): + ``` npm install ``` -#### Storybook +#### Storybook (mdx files) + +Install storybook: https://storybook.js.org/docs/react/get-started/install ``` npm run storybook