From bd56954c9084fbea3e401144eac3191869805e8f Mon Sep 17 00:00:00 2001
From: kavi castelo <kavindu123450@gmail.com>
Date: Mon, 29 Apr 2024 16:50:22 +0530
Subject: [PATCH] update docs

---
 .gitignore           |  3 ++
 .idea/codestream.xml |  1 +
 .idea/workspace.xml  | 31 ++++++++---------
 Docs/Config Guide.md | 42 +++++++++++++++++++++--
 README.md            | 81 +++++++++++++++++++++++++++++++++++++++++++-
 5 files changed, 138 insertions(+), 20 deletions(-)

diff --git a/.gitignore b/.gitignore
index b55a8cf8..203fe916 100644
--- a/.gitignore
+++ b/.gitignore
@@ -23,6 +23,9 @@ target/
 *.iml
 *.ipr
 
+### Environments ###
+.env
+
 ### NetBeans ###
 /nbproject/private/
 /nbbuild/
diff --git a/.idea/codestream.xml b/.idea/codestream.xml
index e0dfafe6..3fe59456 100644
--- a/.idea/codestream.xml
+++ b/.idea/codestream.xml
@@ -2,5 +2,6 @@
 <project version="4">
   <component name="CodeStream">
     <option name="webViewContext" value="{&quot;chatProviderAccess&quot;:&quot;strict&quot;,&quot;currentTeamId&quot;:&quot;&quot;,&quot;currentStreamId&quot;:&quot;&quot;,&quot;pullRequestCheckoutBranch&quot;:false,&quot;isRepositioning&quot;:false,&quot;onboardStep&quot;:0,&quot;panelStack&quot;:[&quot;landing-redirect&quot;],&quot;hasFocus&quot;:false,&quot;channelFilter&quot;:&quot;all&quot;,&quot;channelsMuteAll&quot;:false,&quot;codemarkFileFilter&quot;:&quot;all&quot;,&quot;codemarkTypeFilter&quot;:&quot;all&quot;,&quot;codemarkTagFilter&quot;:&quot;all&quot;,&quot;codemarkBranchFilter&quot;:&quot;all&quot;,&quot;codemarkAuthorFilter&quot;:&quot;all&quot;,&quot;codemarksFileViewStyle&quot;:&quot;inline&quot;,&quot;codemarksShowArchived&quot;:false,&quot;codemarksShowResolved&quot;:false,&quot;codemarksWrapComments&quot;:false,&quot;showFeedbackSmiley&quot;:true,&quot;route&quot;:{&quot;name&quot;:&quot;providerAuth&quot;,&quot;params&quot;:{&quot;fronSignup&quot;:true,&quot;type&quot;:&quot;createTeam&quot;,&quot;fromSignup&quot;:true,&quot;mode&quot;:&quot;strict&quot;,&quot;provider&quot;:&quot;github&quot;}},&quot;spatialViewShowPRComments&quot;:false,&quot;currentPullRequestNeedsRefresh&quot;:{&quot;needsRefresh&quot;:false,&quot;providerId&quot;:&quot;&quot;,&quot;pullRequestId&quot;:&quot;&quot;},&quot;__teamless__&quot;:{&quot;selectedRegion&quot;:&quot;us&quot;},&quot;sessionStart&quot;:1713982224978}" />
+    <option name="webViewContext" value="{&quot;chatProviderAccess&quot;:&quot;strict&quot;,&quot;currentTeamId&quot;:&quot;&quot;,&quot;currentStreamId&quot;:&quot;&quot;,&quot;pullRequestCheckoutBranch&quot;:false,&quot;isRepositioning&quot;:false,&quot;onboardStep&quot;:0,&quot;panelStack&quot;:[&quot;landing-redirect&quot;],&quot;hasFocus&quot;:false,&quot;channelFilter&quot;:&quot;all&quot;,&quot;channelsMuteAll&quot;:false,&quot;codemarkFileFilter&quot;:&quot;all&quot;,&quot;codemarkTypeFilter&quot;:&quot;all&quot;,&quot;codemarkTagFilter&quot;:&quot;all&quot;,&quot;codemarkBranchFilter&quot;:&quot;all&quot;,&quot;codemarkAuthorFilter&quot;:&quot;all&quot;,&quot;codemarksFileViewStyle&quot;:&quot;inline&quot;,&quot;codemarksShowArchived&quot;:false,&quot;codemarksShowResolved&quot;:false,&quot;codemarksWrapComments&quot;:false,&quot;showFeedbackSmiley&quot;:true,&quot;route&quot;:{&quot;name&quot;:&quot;providerAuth&quot;,&quot;params&quot;:{&quot;fronSignup&quot;:true,&quot;type&quot;:&quot;createTeam&quot;,&quot;fromSignup&quot;:true,&quot;mode&quot;:&quot;strict&quot;,&quot;provider&quot;:&quot;github&quot;}},&quot;spatialViewShowPRComments&quot;:false,&quot;currentPullRequestNeedsRefresh&quot;:{&quot;needsRefresh&quot;:false,&quot;providerId&quot;:&quot;&quot;,&quot;pullRequestId&quot;:&quot;&quot;},&quot;__teamless__&quot;:{&quot;selectedRegion&quot;:&quot;us&quot;},&quot;sessionStart&quot;:1714385045172}" />
   </component>
 </project>
\ No newline at end of file
diff --git a/.idea/workspace.xml b/.idea/workspace.xml
index 6278a44d..4873743b 100644
--- a/.idea/workspace.xml
+++ b/.idea/workspace.xml
@@ -5,25 +5,11 @@
   </component>
   <component name="ChangeListManager">
     <list default="true" id="b092ee41-c077-498f-bce5-460d7a6fbea3" name="Changes" comment="">
-<<<<<<< HEAD
-      <change afterPath="$PROJECT_DIR$/client/src/app/components/dashbord/graphs/graphs-air/graphs-air.component.html" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/client/src/app/components/dashbord/graphs/graphs-air/graphs-air.component.scss" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/client/src/app/components/dashbord/graphs/graphs-air/graphs-air.component.spec.ts" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/client/src/app/components/dashbord/graphs/graphs-air/graphs-air.component.ts" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/client/src/app/components/dashbord/graphs/graphs-metro/graphs-metro.component.html" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/client/src/app/components/dashbord/graphs/graphs-metro/graphs-metro.component.scss" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/client/src/app/components/dashbord/graphs/graphs-metro/graphs-metro.component.spec.ts" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/client/src/app/components/dashbord/graphs/graphs-metro/graphs-metro.component.ts" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/.gitignore" beforeDir="false" afterPath="$PROJECT_DIR$/.gitignore" afterDir="false" />
       <change beforePath="$PROJECT_DIR$/.idea/codestream.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/codestream.xml" afterDir="false" />
-=======
-    <list default="true" id="4a36a721-f3b9-4dac-a630-bdf244605597" name="Changes" comment="">
-    <list default="true" id="1b74e0a6-bc86-4c44-930a-d1d3078118d2" name="Changes" comment="">
->>>>>>> cbcae96abf9c046e3883394b4a83b21886fc237e
       <change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/client/src/app/app-routing.module.ts" beforeDir="false" afterPath="$PROJECT_DIR$/client/src/app/app-routing.module.ts" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/client/src/app/app.module.ts" beforeDir="false" afterPath="$PROJECT_DIR$/client/src/app/app.module.ts" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/client/src/app/components/dashbord/graphs/graphs.component.html" beforeDir="false" afterPath="$PROJECT_DIR$/client/src/app/components/dashbord/graphs/graphs.component.html" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/client/src/app/components/dashbord/graphs/graphs.component.ts" beforeDir="false" afterPath="$PROJECT_DIR$/client/src/app/components/dashbord/graphs/graphs.component.ts" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/Docs/Config Guide.md" beforeDir="false" afterPath="$PROJECT_DIR$/Docs/Config Guide.md" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/README.md" beforeDir="false" afterPath="$PROJECT_DIR$/README.md" afterDir="false" />
     </list>
     <option name="SHOW_DIALOG" value="false" />
     <option name="HIGHLIGHT_CONFLICTS" value="true" />
@@ -65,6 +51,10 @@
   <component name="PropertiesComponent">{
   &quot;keyToString&quot;: {
     &quot;ASKED_ADD_EXTERNAL_FILES&quot;: &quot;true&quot;,
+    &quot;RequestMappingsPanelOrder0&quot;: &quot;0&quot;,
+    &quot;RequestMappingsPanelOrder1&quot;: &quot;1&quot;,
+    &quot;RequestMappingsPanelWidth0&quot;: &quot;75&quot;,
+    &quot;RequestMappingsPanelWidth1&quot;: &quot;75&quot;,
     &quot;RunOnceActivity.OpenProjectViewOnStart&quot;: &quot;true&quot;,
     &quot;RunOnceActivity.ShowReadmeOnStart&quot;: &quot;true&quot;,
     &quot;WebServerToolWindowFactoryState&quot;: &quot;false&quot;,
@@ -83,6 +73,13 @@
       <recent name="com.api.air_quality.service" />
     </key>
   </component>
+  <component name="RunDashboard">
+    <option name="configurationTypes">
+      <set>
+        <option value="SpringBootApplicationConfigurationType" />
+      </set>
+    </option>
+  </component>
   <component name="RunManager" selected="Spring Boot.AirQualityApplication">
     <configuration name="AirQualityApplication (1)" type="SpringBootApplicationConfigurationType" factoryName="Spring Boot">
       <module name="air_quality" />
diff --git a/Docs/Config Guide.md b/Docs/Config Guide.md
index f3c7bf14..1377e39d 100644
--- a/Docs/Config Guide.md	
+++ b/Docs/Config Guide.md	
@@ -1,5 +1,40 @@
-# Instructions:
-*Note:* Default configurations are setup for running the project on server.
+# Instructions to set up project to local:
+*Note:* Default configurations are set up for running the project on server.
+
+## Clone the repository:
+```markdown
+https://github.com/kavicastelo/Ethical-AI-driven-Geographic-Analytics-Platform.git
+```
+
+## Pre requests
+- Install Angular CLI 15.2.x
+- Node version 16.19.0
+- Java JDK 17
+- Python 3.10
+- Different runnable environment supportive IDEA (intellij ultimate is recommended)
+
+## Frontend
+- Move to the frontend branch
+  ```markdown
+  git switch frontend
+  ```
+- Move to the `client` directory
+  ```markdown
+  cd client
+  ```
+- Navigates to `src\environment\environment.development.ts`
+- Commented out the production base url and uncomment the local (`port 3269 is recommended and default`)
+- Move to the client directory in terminal and run `npm install --force` command
+  > [!IMPORTANT]
+  > Use --force for install deprecated packages. don't use --legacy-peers
+- Run `ng serve` command to start the development server
+- Project starts to run on `localhost:4200/` port
+
+## Backend
+Move to the `backend` branch
+  ```markdown
+  git switch backend
+  ```
 
 You have to change few files to run the project locally.
 1. AIModel.java (*./src/main/java/com/api/air_quality/model/ai_models/AIModel.java*)
@@ -28,3 +63,6 @@ Add Environment for Python Models.
 - pip install -r requirements.txt (recommended)
 - venv\Scripts\python.exe -m pip install -r requirements.txt (only if **not working** `pip install -r requirements.txt`)
 - deactivate
+
+> [!NOTE]
+> If you're facing any idea error, delete the `.idea` directory and rebuild the project
diff --git a/README.md b/README.md
index f82e5d33..5aa54108 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,84 @@
 # Urban Air Quality Monitoring and Prediction System
 
+![commit activity](https://img.shields.io/github/commit-activity/y/kavicastelo/Ethical-AI-driven-Geographic-Analytics-Platform/main)
+![GitHub language count](https://img.shields.io/github/languages/count/kavicastelo/Ethical-AI-driven-Geographic-Analytics-Platform)
+![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/kavicastelo/Ethical-AI-driven-Geographic-Analytics-Platform/ci.yml?branch=main&label=CI%2FCD%20workflow)
+![Netlify](https://img.shields.io/netlify/84cd0792-91fd-49b8-9fe9-bc52d7e78a3d)
+![Website](https://img.shields.io/website?url=https%3A%2F%2Furban-air-quality-monitor.netlify.app)
+![GitHub License](https://img.shields.io/github/license/kavicastelo/Ethical-AI-driven-Geographic-Analytics-Platform)
+![GitHub Release](https://img.shields.io/github/v/release/kavicastelo/Ethical-AI-driven-Geographic-Analytics-Platform)
+
+
+## System Config
+*Note:* Default configurations are set up for running the project on server.
+
+## Clone the repository:
+```markdown
+https://github.com/kavicastelo/Ethical-AI-driven-Geographic-Analytics-Platform.git
+```
+
+## Pre requests
+- Install Angular CLI 15.2.x
+- Node version 16.19.0
+- Java JDK 17
+- Python 3.10
+- Different runnable environment supportive IDEA (intellij ultimate is recommended)
+
+## Frontend
+- Move to the frontend branch
+  ```markdown
+  git switch frontend
+  ```
+- Move to the `client` directory
+  ```markdown
+  cd client
+  ```
+- Navigates to `src\environment\environment.development.ts`
+- Commented out the production base url and uncomment the local (`port 3269 is recommended and default`)
+- Move to the client directory in terminal and run `npm install --force` command
+  > [!IMPORTANT]
+  > Use --force for install deprecated packages. don't use --legacy-peers
+- Run `ng serve` command to start the development server
+- Project starts to run on `localhost:4200/` port
+
+## Backend
+Move to the `backend` branch
+  ```markdown
+  git switch backend
+  ```
+
+You have to change few files to run the project locally.
+1. AIModel.java (*./src/main/java/com/api/air_quality/model/ai_models/AIModel.java*)
+   - Comment out line **143** and **145**.
+   - Uncomment line **142** and **144**.
+2. All Python models except AIModelPython.py (*./src/main/java/com/api/air_quality/python/\*.py*)
+   - Replace all file paths in `class *ModelPython:` classes with actual file paths.
+   - Ex: `"/app/AI_Models/airHumidity_model.pkl"` to `"./AI_Models/airHumidity_model.pkl"`
+3. CorsConfig.java (*./src/main/java/com/api/air_quality/CorsConfig.java*)
+   - Uncomment line **17** and **29**.
+   - Comment out line **18** and **30**.
+
+If you need to use your own localhost database,
+- Create `.env` file in the root directory of the project.
+- Add `SPRINGBOOT_URL_PYTHON` environment variable in `.env` file. (Optional)
+- Add `PYTHON_EXE_PATH` environment variable in `.env` file. (Optional)
+- Add `DATABASE` environment variable in `.env` file. (Default `Urban_Air`)
+- Add `DATABASE_PORT` environment variable in `.env` file.
+- Add `DATABASE_URI` environment variable in `.env` file.
+- Add `SERVER_PORT` environment variable in `.env` file. (default 3269)
+
+Add Environment for Python Models.
+- <python.exe path to computer drive> -m venv venv
+- source venv\bin\activate (Linux or Mac)
+- .\venv\Scripts\activate (Windows)
+- pip install -r requirements.txt (recommended)
+- venv\Scripts\python.exe -m pip install -r requirements.txt (only if **not working** `pip install -r requirements.txt`)
+- deactivate
+
+> [!NOTE]
+> If you're facing any idea error, delete the `.idea` directory and rebuild the project
+
+
 ## Data Dictionaries
 
 ### 1. Air Quality Data
@@ -29,7 +108,7 @@
 - **location:** Geographic location for which land use information is provided.
 - **land_type:** Type of land use (e.g., Residential, Commercial, Industrial, Park).
 
-## Routes
+## Open APIs
 ### Basic CRUD
 1. Air Quality
    - /api/v1/saveAirQuality