diff --git a/backend/README.md b/backend/README.md index 187d080f..ef841e88 100644 --- a/backend/README.md +++ b/backend/README.md @@ -1,2 +1,15 @@ # EDUC-SDCI + School and District Contact Information application + +### Local Setup + +**`Step 1`**. make sure you have Node.js 14.19.0 installed in your local machine. if not download from here https://nodejs.org/en/ + +**`Step 2`**. Add NODE_ENV=local as environment variable. + +**`Step 4`**. Ask for local.json file which contains all the configs from teammate (Copy local.json into /backend/src/config folder), or create it by following config maps from oc console. + +**`Step 5`**. run `npm install` in command line from backend folder, to install required dependencies. + +**`Step 6`**. run `npm run serve` in command line from backend folder, to run the app.