Added Instructions for Local Setup

.env.example

@@ -0,0 +1,8 @@
+NODE_DEBUG=
+REACT_APP_BASE_URL=
+REACT_APP_FIREBASE_API_KEY=
+REACT_APP_FIREBASE_AUTH_DOMAIN=
+REACT_APP_JUSTPAY_CLIENT_AND_MERCHANT_KEY=
+REACT_APP_MERCHANT_KEY_ID=
+REACT_APP_MMI_BASE_URL=
+REACT_APP_PAYMENT_SDK_ENV=

README.md

@@ -1,4 +1,5 @@
 # Introduction
+
 Biap APP UI Front(end) app - A consumer facing app built on API's provided by biap-node-js-client
 
 # for whom
@@ -8,24 +9,55 @@ This app is intended for anyone building user facing buyer app on ONDC
 Built with React js
 
 # Authentication
+
 - using google outh single page authentication
 - username/password based
 
 # Server Side Events
+
 - Uses server side events to fetch the data from backend without using XHR
 - this makes the app smooth and reactive to incoming data
 
-
 # Geo functionality
+
 - Uses Geo Map functionality using API from ondc-ancillary-app which is wrapper around map my india
 
 # Cloud Calling
- - Uses cloud calling api from ondc-ancillary-app which is a wrapper around knowlarity
 
+- Uses cloud calling api from ondc-ancillary-app which is a wrapper around knowlarity
+
+# Local Setup:
+
+1. Clone the repo using
+
+```
+git clone https://github.com/ONDC-Official/biap-app-ui-front.git
+```
+
+2. Install the Dependencies using
+
+```
+yarn
+```
+
+or
+
+```
+npm install
+```
+
+3. Create a `.env` file in the root directory and add the values for variables mentioned in `.env.example`
+
+4. Run the app using
 
-### `npm start`
+```
+yarn start
+```
 
-Runs the app in the development mode.\
-Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
+or
 
+```
+npm start
+```
 
+5. Open [http://localhost:3000](http://localhost:3000) to view it in your browser. This runs the app in the development mode.

package.json

@@ -9,6 +9,7 @@
     "@testing-library/user-event": "^13.5.0",
     "axios": "^0.24.0",
     "bootstrap": "^5.1.3",
+    "dotenv": "^16.0.3",
     "eventsource": "^2.0.2",
     "firebase": "^9.6.3",
     "jquery": "^3.6.0",