From 62f1b5805251e642c2fd8a4be43e05c47448004e Mon Sep 17 00:00:00 2001
From: Yohannes Abrha Mulaw <123411939+Yohannes19@users.noreply.github.com>
Date: Thu, 20 Jul 2023 23:09:19 +0200
Subject: [PATCH] Update readme.md

Updating the read me
---
 readme.md | 105 +++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 104 insertions(+), 1 deletion(-)

diff --git a/readme.md b/readme.md
index 20a47e2..ac4726a 100644
--- a/readme.md
+++ b/readme.md
@@ -1 +1,104 @@
-Web GIS portal for River Aa 
+# Web Portal Explainer
+
+## Introduction
+
+The Aa-River Web GIS portal is a comprehensive platform developed by the web portal team, enabling spatio-temporal analysis and visualization of the River Aa in the Münster region of Germany. The portal serves as a central hub for accessing and analyzing river-related data, providing an intuitive and user-friendly interface for exploration.
+
+## Functionalities
+
+The web portal offers a wide range of functionalities to facilitate data analysis and visualization:
+
+1. Dashboard: The fully functional and interactive dashboard provides a comprehensive overview of the river's data. Users can access various visualizations and tools to gain insights into the river's condition.
+2. 2-D Visualization: The platform offers 2-D visualization capabilities for different map images, including RGB images, multispectral images, NDVI comparisons, flight paths, and land cover data. These visualizations help in understanding changes over time.
+3. 3D Visualization: Users can experience 3D visualization features, such as LiDAR point cloud visualizations and mesh orthomosaics. These immersive visualizations provide detailed examination of the river's topography.
+4. Esri Cloud Services Integration: Seamlessly integrated with Esri Cloud Services, the web portal allows access and analysis of multispectral data and sense box information, expanding the range of available data sources.
+
+For more information, check out our manuscript.
+
+## Live Demo
+
+For a live demo, visit: [Web Portal Demo](https://web-portal.herokuapp.com/)or (https://giv-project2.uni-muenster.de)
+
+## Running Locally
+
+To run the Aa-River Web GIS portal locally, follow these steps:
+
+1. Clone the repository to your local machine.
+2. Install the required dependencies using `npm install`.
+3. Start the server using `npm start`.
+4. Access the web portal through your web browser at http://localhost:9000.
+
+## Built With
+
+- Frontend: HTML, CSS, JavaScript, Bootstrap
+- Backend: Node.js
+- Middleware: GeoServer
+- Database: PostgreSQL
+- Libraries: Leaflet, Leaflet-draw, ShpJs, Chart.js, Potree, PotreeConverter
+- Desktop Software: QGIS
+- Documentation: GitHub and MS Word
+
+## Prerequisites
+
+- Node.js installed
+- PostgreSQL database with PostGIS and postgis_raster extensions enabled
+- Geoserver 2.23.0 version
+- NPM (Node Package Manager)
+
+## Installation
+
+1. Clone the repository to your local machine.
+2. Install the required dependencies using `npm install`.
+
+## Usage
+
+The Aa-River Web GIS portal provides an intuitive and user-friendly platform to access and analyze river-related data. Users can explore various visualizations and tools to gain valuable insights into the river's condition and changes over time.
+
+## Roadmap
+
+- Improve Changelog
+- Add "Back to Top" links
+- Include a "components" document for easy copying and pasting of sections
+- Add support for different interfaces
+- Continuously update and address open issues to enhance features
+
+## Key Metrics
+
+The success and impact of the Aa-River Web GIS portal can be measured through key metrics:
+
+- User Engagement: Evaluate the number of users and their interaction with the platform to assess user engagement and satisfaction.
+- Data Accessibility: Measure the ease of access to various datasets, including RGB images, multispectral images, and sense box data, to ensure data availability and user-friendliness.
+- Visualization Effectiveness: Gather user feedback to determine the effectiveness of visualizations in conveying information and facilitating spatio-temporal analysis.
+- Collaboration and Interoperability: Assess the platform's ability to collaborate with other teams and seamlessly share data, fostering collaborative research.
+- User Satisfaction: Conduct user surveys to gauge overall user satisfaction with the web portal's functionalities and performance.
+
+## Contributors and Credits
+
+The success of the Aa-River Web GIS portal is the result of the dedicated efforts of the following team members:
+
+- Yohannes Abrha Mulaw (542515)
+- Babatunde Aremu (542577)
+- Lukumon Olaitan Lateef (542512)
+- Muhammad Omar Khan (542512)
+- Yeshey Samdrup (542517)
+
+The whole project concluded as the result of a research collaboration between the students, faculty, and the IT department of WWU Munster University.
+
+We thank Prof1, Prof2, Prof3, and the WWU IT Department for their support and constructive feedback.
+
+## License
+
+The web portal is available under the WWU IT Server Domain/License. See the LICENSE file for details.
+
+## Contact
+
+If you have any questions, feel free to open the portal or contact the Web Portal Team.
+
+## Acknowledgments
+
+We extend our appreciation to the following resources that have been instrumental in the development of the Aa-River Web GIS portal:
+
+- Potree (2015) - [https://github.com/potree/potree](https://github.com/potree/potree)
+- PotreeConverter (2015) - [https://github.com/potree/PotreeConverter](https://github.com/potree/PotreeConverter)
+- Leaflet (2011) - [https://github.com/Leaflet/Leaflet](https://github.com/Leaflet/Leaflet)
+