Merge pull request #298 from CivicDataLab/update/readme

Readme update

Author: Deepthi-Chand

README.md

@@ -1,14 +1,14 @@
 # IDS-DRR
 
-This is a frontend repository of IDS-DRR built using React and Next.js , GraphQl as the backend
+This is the frontend repository of IDS-DRR built using **React**, **Next.js**, and **GraphQL**.
 
 ## Dependencies
 
 The following dependencies must be available globally on your system:
 
 - Download and install [https://nodejs.org/en/](NodeJS LTS v18+) and npm
 
-## Installation
+## Installation & Setup
 
 1. Clone the repository
 
@@ -20,7 +20,11 @@ The following dependencies must be available globally on your system:
 
 3. Install the dependencies.
 
-`npm install`
+`npm install --legacy-peer-deps`
+
+4. Create your local environment configuration from the sample file:
+
+`cp env.sample .env.local`
 
 ## Usage
 

env.sample

@@ -1,4 +1,16 @@
 BACKEND_URL="https://api.dataspace.open-contracting.in"
+NEXT_PUBLIC_BACKEND_URL="https://api.dataspace.open-contracting.in"
 DATA_MANAGEMENT_LAYER_URL="https://drr.backend.open-contracting.in"
-NEXT_PUBLIC_BACKEND_URL= 'https://api.dataspace.open-contracting.in'
-NEXT_PUBLIC_DATA_MANAGEMENT_LAYER_URL="https://drr.backend.open-contracting.in"
+NEXT_PUBLIC_DATA_MANAGEMENT_LAYER_URL="https://drr.backend.open-contracting.in"
+
+
+NEXT_PUBLIC_GOOGLE_ANALYTICS_APP_ID=""
+NEXT_PUBLIC_GOOGLE_TRANSLATE_KEY=""
+
+SITE_URL=""
+
+SENTRY_AUTH_TOKEN=""
+SENTRY_DSN_URL=""
+SENTRY_ORG_NAME="civicdatalab-india"
+SENTRY_PROJECT_NAME=""
+SENTRY_URL=""