From 240b7b21b46767a9a39423637bede6b8204b871c Mon Sep 17 00:00:00 2001 From: Forest Anderson Date: Thu, 2 Jun 2022 18:02:05 +0000 Subject: [PATCH] Cleaned up the client readme file Co-authored-by: Quynh Vo Co-authored-by: Rohan --- client/{readme.md => README.md} | 24 ++++++++++++++++++------ 1 file changed, 18 insertions(+), 6 deletions(-) rename client/{readme.md => README.md} (66%) diff --git a/client/readme.md b/client/README.md similarity index 66% rename from client/readme.md rename to client/README.md index b8bbfe08..cddfc5b4 100644 --- a/client/readme.md +++ b/client/README.md @@ -2,6 +2,12 @@ # Client +To start the dev server for the client, first `cd` into the client directory: + +``` +cd client +``` + # Setup ## 1. Install Yarn @@ -10,13 +16,19 @@ This [guide](https://classic.yarnpkg.com/en/docs/install/#mac-stable) will descr ## 2. Install Dependencies -```bash +``` yarn install ``` -## 3. Start the app +## 3. Set up the env file -```bash +``` +mv .env_sample .env +``` + +## 4. Start the app + +``` yarn run dev ``` @@ -24,18 +36,18 @@ yarn run dev ## Test -```bash +``` yarn run test ``` ## Format -```bash +``` yarn run format ``` ## Storybook -```bash +``` yarn storybook ```