Skip to content

Commit

Permalink
added README instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
shaunlumbcgov committed Jun 26, 2023
1 parent e541ef2 commit 629a725
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions backend/README.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 629a725

Please sign in to comment.