Merge pull request #34 from cphelefu/refactored-pr

Refactored pr
Canadian-Geospatial-Platform · Oct 2, 2024 · db84f61 · db84f61
2 parents 0687ef2 + 464d67a
commit db84f61
Show file tree

Hide file tree

Showing 137 changed files with 353 additions and 388 deletions.
diff --git a/docs/architecture.md b/docs/architecture.md
@@ -0,0 +1,87 @@
+# GeoView Demo Architecture
+
+## Overview
+
+The GeoView Demo project is designed to showcase the capabilities of the GeoView library. 
+GeoViewDemo offers users the following functionalities;
+- Ability to build and test their config files via a UI.
+- A place to try GeoView API functions and see the code that triggers such functions.
+This document provides an overview of the architecture, including the main components and their interactions.
+
+![image](https://github.com/user-attachments/assets/b971db56-442c-4a90-987c-3204e5eed9ef)
+
+
+## The UI Structure
+
+The UI structure consists mainly of two sections. The map and the drawers sections.
+The map basically renders the generated map.
+The drawer consists of different tabs - each displaying information about the map or offering a way of manipulating the map.
+
+## Folder Structure
+
+The GeoView Demo project follows a structured layout to maintain clarity and organization. Below is an overview of the main folders and their purposes:
+
+```
+/geoview-demo
+├── /docs
+├── /src
+│   ├── /components
+│   ├── /providers
+│   ├── /routes
+│   └── /pages
+│   └── /constants.ts
+│   └── /types.ts
+```
+
+### /docs
+- **Purpose**: Contains all the documentation related to the project, including architectural overviews, API documentation, and user guides.
+
+### /src
+- **Purpose**: The main source code of the project.
+- **Subfolders**:
+    - **/components**: Contains React components used in the UI.
+    - **/routes**: Contains routes for the application. At the moment the application has only one route (/default); but can be expanded to add more routes.
+    - **/providers**: This folder containers all our providers used in the application.
+    - **/routes**: Pages associated with routes.
+
+### /public
+- **Purpose**: Static files that are publicly accessible, such as HTML templates, images, and other assets.
+
+This folder structure promotes a clean separation of concerns, making the project easier to navigate and maintain.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/index.html b/index.html
@@ -2,9 +2,9 @@
 <html lang="en">
   <head>
     <meta charset="UTF-8" />
-    <link rel="icon" type="image/svg+xml" href="/favicon.ico" />
+    <link rel="icon" type="image/svg+xml" href="https://canadian-geospatial-platform.github.io/geoview/favicon.ico" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <script src="https://canadian-geospatial-platform.github.io/geoview/cgpv-main.js"></script>
+    <script src="https://canadian-geospatial-platform.github.io/geoview/public/cgpv-main.js"></script>
     <title>GeoView Demo Page</title>
   </head>
   <body>

diff --git a/public/favicon.ico b/public/favicon.ico
diff --git a/public/img/Check.png b/public/img/Check.png
diff --git a/public/img/GeoCaIcon.svg b/public/img/GeoCaIcon.svg
diff --git a/public/img/Logo.png b/public/img/Logo.png
diff --git a/public/img/Marker.png b/public/img/Marker.png
diff --git a/public/img/guide/datatable/action_icon_filters.png b/public/img/guide/datatable/action_icon_filters.png
diff --git a/public/img/guide/datatable/column_action.svg b/public/img/guide/datatable/column_action.svg
diff --git a/public/img/guide/datatable/column_hide_25.svg b/public/img/guide/datatable/column_hide_25.svg
diff --git a/public/img/guide/datatable/column_show.svg b/public/img/guide/datatable/column_show.svg
diff --git a/public/img/guide/datatable/density.svg b/public/img/guide/datatable/density.svg
diff --git a/public/img/guide/datatable/export.svg b/public/img/guide/datatable/export.svg
diff --git a/public/img/guide/datatable/filter.png b/public/img/guide/datatable/filter.png
diff --git a/public/img/guide/datatable/filter_clear_25.svg b/public/img/guide/datatable/filter_clear_25.svg
diff --git a/public/img/guide/datatable/filter_open.png b/public/img/guide/datatable/filter_open.png
diff --git a/public/img/guide/datatable/filter_toggle.svg b/public/img/guide/datatable/filter_toggle.svg
diff --git a/public/img/guide/datatable/filter_toggle_25.svg b/public/img/guide/datatable/filter_toggle_25.svg
diff --git a/public/img/guide/datatable/fullscreen.svg b/public/img/guide/datatable/fullscreen.svg
diff --git a/public/img/guide/datatable/layer_features.png b/public/img/guide/datatable/layer_features.png
diff --git a/public/img/guide/datatable/pin_left_25.svg b/public/img/guide/datatable/pin_left_25.svg
diff --git a/public/img/guide/datatable/pin_right_25.svg b/public/img/guide/datatable/pin_right_25.svg
diff --git a/public/img/guide/datatable/settings.png b/public/img/guide/datatable/settings.png
diff --git a/public/img/guide/datatable/zoom.svg b/public/img/guide/datatable/zoom.svg
diff --git a/public/img/guide/footer/back_arrow_30.svg b/public/img/guide/footer/back_arrow_30.svg
diff --git a/public/img/guide/footer/back_arrow_50.svg b/public/img/guide/footer/back_arrow_50.svg
diff --git a/public/img/guide/footer/bar_chart.png b/public/img/guide/footer/bar_chart.png
diff --git a/public/img/guide/footer/chart.png b/public/img/guide/footer/chart.png
diff --git a/public/img/guide/footer/chart1.png b/public/img/guide/footer/chart1.png
diff --git a/public/img/guide/footer/chart_30.svg b/public/img/guide/footer/chart_30.svg
diff --git a/public/img/guide/footer/chart_x.png b/public/img/guide/footer/chart_x.png
diff --git a/public/img/guide/footer/checkbox.png b/public/img/guide/footer/checkbox.png
diff --git a/public/img/guide/footer/data_table.svg b/public/img/guide/footer/data_table.svg
diff --git a/public/img/guide/footer/datatable.png b/public/img/guide/footer/datatable.png
diff --git a/public/img/guide/footer/details.png b/public/img/guide/footer/details.png
diff --git a/public/img/guide/footer/direction_arrow_30.svg b/public/img/guide/footer/direction_arrow_30.svg
diff --git a/public/img/guide/footer/eye.png b/public/img/guide/footer/eye.png
diff --git a/public/img/guide/footer/eye_disabled.png b/public/img/guide/footer/eye_disabled.png
diff --git a/public/img/guide/footer/eye_not_visible.png b/public/img/guide/footer/eye_not_visible.png
diff --git a/public/img/guide/footer/footer.png b/public/img/guide/footer/footer.png
diff --git a/public/img/guide/footer/footer_tabs.png b/public/img/guide/footer/footer_tabs.png
diff --git a/public/img/guide/footer/forward_arrow_30.svg b/public/img/guide/footer/forward_arrow_30.svg
diff --git a/public/img/guide/footer/icon_multiple.png b/public/img/guide/footer/icon_multiple.png
diff --git a/public/img/guide/footer/icon_single.png b/public/img/guide/footer/icon_single.png
diff --git a/public/img/guide/footer/layers_30.svg b/public/img/guide/footer/layers_30.svg
diff --git a/public/img/guide/footer/lock_30.svg b/public/img/guide/footer/lock_30.svg
diff --git a/public/img/guide/footer/pie_chart.png b/public/img/guide/footer/pie_chart.png
diff --git a/public/img/guide/footer/play_arrow.svg b/public/img/guide/footer/play_arrow.svg
diff --git a/public/img/guide/footer/play_arrow_30.svg b/public/img/guide/footer/play_arrow_30.svg
diff --git a/public/img/guide/footer/swap_vert_FILL0_wght400_GRAD0_opsz24.svg b/public/img/guide/footer/swap_vert_FILL0_wght400_GRAD0_opsz24.svg
diff --git a/public/img/guide/footer/time_slider.png b/public/img/guide/footer/time_slider.png
diff --git a/public/img/guide/footer/time_slider_30.svg b/public/img/guide/footer/time_slider_30.svg
diff --git a/public/img/guide/footer/view_25.svg b/public/img/guide/footer/view_25.svg
diff --git a/public/img/guide/geosearch/clear.svg b/public/img/guide/geosearch/clear.svg
diff --git a/public/img/guide/geosearch/geofilter_en.png b/public/img/guide/geosearch/geofilter_en.png
diff --git a/public/img/guide/geosearch/geofilter_fr.png b/public/img/guide/geosearch/geofilter_fr.png
diff --git a/public/img/guide/geosearch/geolocator.svg b/public/img/guide/geosearch/geolocator.svg
diff --git a/public/img/guide/geosearch/geolocator_20.svg b/public/img/guide/geosearch/geolocator_20.svg
diff --git a/public/img/guide/geosearch/searchbar_en.png b/public/img/guide/geosearch/searchbar_en.png
diff --git a/public/img/guide/geosearch/searchbar_fr.png b/public/img/guide/geosearch/searchbar_fr.png
diff --git a/public/img/guide/geosearch/visiblemap_en.png b/public/img/guide/geosearch/visiblemap_en.png
diff --git a/public/img/guide/geosearch/visiblemap_fr.png b/public/img/guide/geosearch/visiblemap_fr.png
diff --git a/public/img/guide/layers/add_25.svg b/public/img/guide/layers/add_25.svg
diff --git a/public/img/guide/layers/add_layer.png b/public/img/guide/layers/add_layer.png
diff --git a/public/img/guide/layers/check.png b/public/img/guide/layers/check.png
diff --git a/public/img/guide/layers/details.png b/public/img/guide/layers/details.png
diff --git a/public/img/guide/layers/details.svg b/public/img/guide/layers/details.svg
diff --git a/public/img/guide/layers/group.png b/public/img/guide/layers/group.png
diff --git a/public/img/guide/layers/group.svg b/public/img/guide/layers/group.svg
diff --git a/public/img/guide/layers/highlight.png b/public/img/guide/layers/highlight.png
diff --git a/public/img/guide/layers/highlight_60.svg b/public/img/guide/layers/highlight_60.svg
diff --git a/public/img/guide/layers/opacity.png b/public/img/guide/layers/opacity.png
diff --git a/public/img/guide/layers/refresh.png b/public/img/guide/layers/refresh.png
diff --git a/public/img/guide/layers/refresh_60.svg b/public/img/guide/layers/refresh_60.svg
diff --git a/public/img/guide/layers/remove_25.svg b/public/img/guide/layers/remove_25.svg
diff --git a/public/img/guide/layers/settings.png b/public/img/guide/layers/settings.png
diff --git a/public/img/guide/layers/sort_25.svg b/public/img/guide/layers/sort_25.svg
diff --git a/public/img/guide/layers/table_view.svg b/public/img/guide/layers/table_view.svg
diff --git a/public/img/guide/layers/table_view_60.svg b/public/img/guide/layers/table_view_60.svg
diff --git a/public/img/guide/layers/view.png b/public/img/guide/layers/view.png
diff --git a/public/img/guide/layers/zoom.png b/public/img/guide/layers/zoom.png
diff --git a/public/img/guide/layers/zoom_60.svg b/public/img/guide/layers/zoom_60.svg
diff --git a/public/img/guide/navigation/attribute.svg b/public/img/guide/navigation/attribute.svg
diff --git a/public/img/guide/navigation/chevron_left.svg b/public/img/guide/navigation/chevron_left.svg
diff --git a/public/img/guide/navigation/chevron_overview.png b/public/img/guide/navigation/chevron_overview.png
diff --git a/public/img/guide/navigation/chevron_up.svg b/public/img/guide/navigation/chevron_up.svg
diff --git a/public/img/guide/navigation/crosshair.svg b/public/img/guide/navigation/crosshair.svg
diff --git a/public/img/guide/navigation/down_arrow_20.svg b/public/img/guide/navigation/down_arrow_20.svg
diff --git a/public/img/guide/navigation/enable.png b/public/img/guide/navigation/enable.png
diff --git a/public/img/guide/navigation/fix_north.png b/public/img/guide/navigation/fix_north.png
diff --git a/public/img/guide/navigation/fullscreen.svg b/public/img/guide/navigation/fullscreen.svg
diff --git a/public/img/guide/navigation/geolocation.png b/public/img/guide/navigation/geolocation.png
diff --git a/public/img/guide/navigation/geolocation.svg b/public/img/guide/navigation/geolocation.svg
diff --git a/public/img/guide/navigation/home.svg b/public/img/guide/navigation/home.svg
diff --git a/public/img/guide/navigation/keyboard_nav.png b/public/img/guide/navigation/keyboard_nav.png
diff --git a/public/img/guide/navigation/map_info.png b/public/img/guide/navigation/map_info.png
diff --git a/public/img/guide/navigation/minus.svg b/public/img/guide/navigation/minus.svg
diff --git a/public/img/guide/navigation/overview.png b/public/img/guide/navigation/overview.png
diff --git a/public/img/guide/navigation/plus.svg b/public/img/guide/navigation/plus.svg
diff --git a/public/img/guide/navigation/up_arrow.svg b/public/img/guide/navigation/up_arrow.svg
diff --git a/public/img/guide/navigation/up_arrow_20.svg b/public/img/guide/navigation/up_arrow_20.svg
diff --git a/public/img/guide/sidebar/about.svg b/public/img/guide/sidebar/about.svg
diff --git a/public/img/guide/sidebar/basemap.svg b/public/img/guide/sidebar/basemap.svg