diff --git a/README.md b/README.md index d28fcb0..20d6925 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,9 @@ # Webstore (a.k.a. Digital Storefront) - [Getting Started](#getting-started) + - [Creating New Pages](#creating-new-pages) - [Environment Variables](#environment-variables) - - [Creating the marketplace app](#creating-the-marketplace-app) + - [Creating The Marketplace App](#creating-the-marketplace-app) - [Provider ID](#provider-id) - [Authentication](#authentication) - [Provider Credentials](#provider-credentials) @@ -14,7 +15,7 @@ - [Testing](#testing) - [Jest](#jest) - [Cypress](#cypress) - - [Setup your Cypress env variables](#setup-your-cypress-env-variables) + - [Cypress ENV Variables](#cypress-env-variables) - [Deployment](#deployment) --- @@ -22,12 +23,16 @@ ## Getting Started 1. Confirm that your local node version is compliant with the node engine in the package.json + - If it isn't compliant, update it. (e.g., use [Node Version Manager](https://github.com/nvm-sh/nvm)) 2. `yarn` to install automatic dependencies - 3. `yarn dev` to boot this app as a server - - Open [http://localhost:3000](http://localhost:3000) with your browser to see the result - 4. Create pages by adding them to the `pages` directory - - Reference [this documentation](https://nextjs.org/docs/basic-features/pages) for more info about pages - - The page auto-updates as you edit the file, although there may be a few seconds delay + 3. Configure your [environment variables](https://github.com/scientist-softserv/webstore/wiki/Environment-Variables) + 4. `yarn dev` to boot this app as a server + - Once the logs show that the client and server have been successfully compiled, open [http://localhost:3000](http://localhost:3000) in your browser to see the result + +### Creating New Pages +Create pages by adding them to the `pages` directory. + - Reference [this documentation](https://nextjs.org/docs/basic-features/pages) for more info about pages + - The page auto-updates as you edit the file, although there may be a few seconds delay