From c9524d08ca34c6965f83b7f9b087d19f2ebf2366 Mon Sep 17 00:00:00 2001 From: PhilippeWS <91435899+PhilippeWS@users.noreply.github.com> Date: Sat, 28 May 2022 19:17:16 -0700 Subject: [PATCH] Create README.md --- README.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 91702e1..b4e64a2 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,19 @@ # BE-scheduling -## Accessible FrontEnd Link: -https://dog-groomings.herokuapp.com/ - -## Accessible BackEnd Link: +Accessible Link: https://dog-grooming-api.herokuapp.com/ +## Quick Start Instructions + 1. Clone Github Repository to Local Machine. + 2. Run `npm install` to install all necessary packages. + 3. Create .env file in the root folder. + 4. Add the following variables + `MONGODB_URI: Description: The URL to the cloud hosted DB + PASSWORD_SALT: Salt used in encrypting passwords + TOKEN_SECRET: Used to verifty user JWT + PORT: Port to utilize should the connection to the cloud hosted DB fail` + 5. Run `npm run dev` to launch. + # CI/CD Steps: npm ci npm run build --if-present