Merge pull request #917 from airqo-platform/ft-netmanagerEnvSample

Creating .env.sample file and updating README.md according to it.

netmanager/.env.sample

@@ -0,0 +1,16 @@
+REACT_APP_BASE_URL=https://staging-platform.airqo.net/api/v1/
+REACT_APP_BASE_ANALYTICS_URL=
+REACT_APP_BASE_AUTH_SERVICE_URL=
+REACT_APP_BASE_DATA_MANAGEMENT_URL=
+REACT_APP_BASE_DEVICE_MONITORING_URL=
+REACT_APP_BASE_DEVICE_REGISTRY_URL= 
+REACT_APP_BASE_LOCATE_URL=
+REACT_APP_BASE_LOCATION_REGISTRY_URL=
+REACT_APP_BASE_PREDICT_URL=
+REACT_APP_MAX_CONFIDENCE_INTERVAL=
+REACT_APP_CLOUDINARY_NAME=abcdef
+REACT_APP_CLOUDINARY_PRESET=abcdef
+REACT_APP_MAPBOX_TOKEN=pk.ey123abc
+REACT_APP_JIRA_KEY=abcdef
+NODE_PATH=src/
+PORT=5000

netmanager/README.md

@@ -1,30 +1,33 @@
 # Netmanager Application
+
 This application is used for monitoring, device registration, location registration. Can be accessed here: https://staging-platform.airqo.net/ and https://platform.airqo.net/
 
 ## Local Setup
+
 npm is our package manager of choice here. Check out setup instructions [here](https://nodejs.org/dist/) if you don't have it installed already. <br/><br/>
 **Note: This project is currently using node version 14.**
 
 To run the app, enter the project directory <br/>
-**a) Add the `.env` file to the root folder.** You can find it [here](https://drive.google.com/drive/folders/1RYuukiTYgVxMBlSa4K8miLYiM_W4T86o)<br/>
+
+**a) Add the `.env` file**
+
+You need to fill actual values to the environment variables while creating the respective `.env` file from [.env.sample](./.env.sample) file.
+Note that the variables with no (dummy)values are not required to get the app up and running.
 
 **b) Install all the needed dependencies**
-
-
+
     npm install
+
 **c) Run in Development mode**
-
 
     npm run dev
 
 **d) Run in Staging mode**
-
 
     npm run stage
 
 **e) Run in Production mode**
-
 
     npm run prod
 
-Now, the application should be running on `http://localhost:5000`.
+Now, the application should be running on `http://localhost:5000`.