# kamrul28890/indot-solar-suitability-map-2 architecture > Architecture diagram of the GitHub repository kamrul28890/indot-solar-suitability-map-2, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-06-29). It is an AI-made overview: check details against the source. - Interactive diagram: https://gitdiagram.com/kamrul28890/indot-solar-suitability-map-2 - Repository: https://github.com/kamrul28890/indot-solar-suitability-map-2 ## Overview 1. **Repository purpose** - This repo builds the **INDOT Solar Suitability Map** for SPR 4862 / Indiana Solar Roadmap. - The **active product is `website/`**: a static, browser-delivered React + Vite application with a maintainer-facing Map Builder. 2. **Primary runtime boundary** - The public site is **static** at runtime; it does not depend on a live application server for normal use. - It reads `website/data/processed/manifest.json` plus the referenced GeoJSON files from the deployed site assets. 3. **Core public application** - The user-facing app lives under `website/src/` and is organized by route: - `Home`, `Map`, `Insights`, `Criteria`, `Data`, `Faq`, `About`, `Contact`, and legal pages. - `website/src/components/` contains shared UI shells, headers, cards, charts, map controls, and layout primitives. 4. **Map subsystem** - The map experience is centered in `website/src/map/` and backed by Leaflet-style map components and styling. - It includes filtering, legends, detail panels, score bars, and criterion tables, indicating a data-rich GIS-style interaction model. - Map behavior is driven by shared utilities such as filtering, selection, search, stats, and distance calculations. 5. **Data-loading and app-state flow** - `website/src/utils/useAppData.js` is the main bridge from deployed data files into the React app. - The flow is: **processed manifest → referenced GeoJSON layers → UI routes/components**. - This keeps the site decoupled from backend services and makes the deployed bundle portable. 6. **Insights and analytics layer** - `website/src/components/charts/` and `website/src/routes/Insights/` implement the reporting/analysis side of the site. - These views consume the same processed datasets to render summary metrics, distributions, and comparison visuals alongside the map. 7. **Browser-based Map Builder** - The builder lives in `website/src/builder/` and is a separate workflow within the same app. - Its step flow is **Upload → Edit → Preview**, and it accepts the three INDOT shapefile datasets for maintainer updates. - Builder logic includes shapefile parsing, geometry repair, normalization, validation, package creation, and schema rules. 8. **Data update package model** - The builder exports a **drop-in ZIP update package** containing: - `data/processed/manifest.json` - `all_candidate_sites.geojson` - `facility_scored.geojson` - `row_scored.geojson` - This package is meant to be applied to a local checkout or release artifact, then rebuilt for publication. 9. **Processing and validation utilities** - `website/src/builder/lib/` contains the critical data pipeline pieces for converting source shapefiles into publishable map assets. - Tests alongside these modules show the repo treats data transformation correctness as a first-class concern. 10. **Build, release, and deployment** - The site is built with **Vite** and published from `website/dist/`. - GitHub Actions in `.github/workflows/` deploy the public site, with `deploy-public-site.yml` targeting the public website repository using a deploy token. - The static build is parameterized by environment variables such as `VITE_DATA_MODE` and `VITE_PUBLIC_BASE`. 11. **Platform and packaging support** - There are helper scripts for release prep, Windows packaging, and verification under `website/scripts/` and `website/packaging/`. - A `Dockerfile` and `docker-compose.yml` exist, but the core architecture remains static-site-first rather than containerized backend service-first. 12. **Testing and quality boundaries** - The repo includes unit tests for builder logic, map utilities, chart/data helpers, and API/export helpers. - This separates concerns into: - data transformation correctness, - map/UI behavior, - export/package generation, - and deployment readiness checks. 13. **Legacy/archive boundary** - `archive/` contains retired prototypes, previous editor implementations, and reference material. - These folders are not part of the active architecture, but they show earlier iterations that split frontend/backend more explicitly than the current static site. 14. **Operational summary for a diagram** - The clearest architecture diagram is: - **Source shapefiles / processed GeoJSON assets** feeding - **static React/Vite site** with two major user paths: - public map/insights browsing, - maintainer Map Builder export flow. - Publishing is a separate CI/CD path that packages the built static site to GitHub Pages/public hosting. Main entry points: [`website/src/builder/lib`](https://github.com/kamrul28890/indot-solar-suitability-map-2/tree/main/website/src/builder/lib) (Builder core), [`website/src/App.jsx`](https://github.com/kamrul28890/indot-solar-suitability-map-2/blob/main/website/src/App.jsx) (Site shell), [`website/src/routes`](https://github.com/kamrul28890/indot-solar-suitability-map-2/tree/main/website/src/routes) (Public pages), [`website/src/map`](https://github.com/kamrul28890/indot-solar-suitability-map-2/tree/main/website/src/map) (Map experience) ## Diagram (Mermaid) ```mermaid flowchart TD subgraph group_website_active["Active website"] node_processed_assets[("Processed data
static geojson
[manifest.json]")] node_app_data_hook["Data hook
react hook
[useAppData.js]"] node_site_shell["Site shell
app shell
[App.jsx]"] node_site_routes["Public pages
route set"] node_shared_ui["Shared UI
components"] node_map_experience["Map experience
gis ui"] node_insights_views["Insights views
analysis ui"] node_chart_lib["Charts
visualization components"] node_map_state["Map state
map utilities"] end subgraph group_builder["Map Builder"] node_builder_flow["Builder flow
maintainer workflow"] node_builder_core["Builder core
data pipeline"] node_builder_schema["Schema rules
validation schema
[schema.js]"] node_update_package[("Update ZIP
export package
[buildPackage.js]")] end subgraph group_delivery["Build & deploy"] node_build_pipeline["Build pipeline
vite release
[vite.config.js]"] node_deploy_actions["Deploy actions
ci/cd"] node_public_hosting[("Public hosting
static site")] end subgraph group_archive["Archive"] node_legacy_editor["Legacy editor
archive app"] end node_processed_assets -->|"loads"| node_app_data_hook node_app_data_hook -->|"feeds"| node_site_shell node_site_shell -->|"renders"| node_site_routes node_site_shell -->|"composes"| node_shared_ui node_site_routes -->|"hosts"| node_map_experience node_site_routes -->|"hosts"| node_insights_views node_insights_views -->|"uses"| node_chart_lib node_map_experience -->|"depends on"| node_map_state node_map_experience -->|"uses"| node_shared_ui node_builder_flow -->|"drives"| node_builder_core node_builder_core -->|"validates against"| node_builder_schema node_builder_core -->|"creates"| node_update_package node_update_package -->|"replaces"| node_processed_assets node_build_pipeline -->|"produces"| node_public_hosting node_deploy_actions -->|"publishes"| node_public_hosting node_legacy_editor -.->|"precedes"| node_builder_core click node_processed_assets "https://github.com/kamrul28890/indot-solar-suitability-map-2/blob/main/website/data/processed/manifest.json" click node_app_data_hook "https://github.com/kamrul28890/indot-solar-suitability-map-2/blob/main/website/src/utils/useAppData.js" click node_site_shell "https://github.com/kamrul28890/indot-solar-suitability-map-2/blob/main/website/src/App.jsx" click node_site_routes "https://github.com/kamrul28890/indot-solar-suitability-map-2/tree/main/website/src/routes" click node_shared_ui "https://github.com/kamrul28890/indot-solar-suitability-map-2/tree/main/website/src/components" click node_map_experience "https://github.com/kamrul28890/indot-solar-suitability-map-2/tree/main/website/src/map" click node_insights_views "https://github.com/kamrul28890/indot-solar-suitability-map-2/tree/main/website/src/routes/Insights" click node_chart_lib "https://github.com/kamrul28890/indot-solar-suitability-map-2/tree/main/website/src/components/charts" click node_map_state "https://github.com/kamrul28890/indot-solar-suitability-map-2/tree/main/website/src/utils" click node_builder_flow "https://github.com/kamrul28890/indot-solar-suitability-map-2/tree/main/website/src/builder/steps" click node_builder_core "https://github.com/kamrul28890/indot-solar-suitability-map-2/tree/main/website/src/builder/lib" click node_builder_schema "https://github.com/kamrul28890/indot-solar-suitability-map-2/blob/main/website/src/builder/config/schema.js" click node_update_package "https://github.com/kamrul28890/indot-solar-suitability-map-2/blob/main/website/src/builder/lib/buildPackage.js" click node_build_pipeline "https://github.com/kamrul28890/indot-solar-suitability-map-2/blob/main/website/vite.config.js" click node_deploy_actions "https://github.com/kamrul28890/indot-solar-suitability-map-2/blob/main/.github/workflows/deploy-public-site.yml" click node_public_hosting "https://github.com/kamrul28890/indot-solar-suitability-map-2/tree/main/website/public_site" click node_legacy_editor "https://github.com/kamrul28890/indot-solar-suitability-map-2/tree/main/archive/phase2_editor" classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554 classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337 classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81 classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a class node_processed_assets,node_app_data_hook,node_site_shell,node_site_routes,node_shared_ui,node_map_experience,node_insights_views,node_chart_lib,node_map_state toneBlue class node_builder_flow,node_builder_core,node_builder_schema,node_update_package toneAmber class node_build_pipeline,node_deploy_actions,node_public_hosting toneMint class node_legacy_editor toneRose ``` ## Components ### Active website Primary static React/Vite application and its data flow. - [Processed data](https://github.com/kamrul28890/indot-solar-suitability-map-2/blob/main/website/data/processed/manifest.json): static geojson · Deployed manifest and referenced GeoJSON layers consumed by the public site. · `website/data/processed/manifest.json` - [Data hook](https://github.com/kamrul28890/indot-solar-suitability-map-2/blob/main/website/src/utils/useAppData.js): react hook · Main bridge from deployed assets into the React app. · `website/src/utils/useAppData.js` - [Site shell](https://github.com/kamrul28890/indot-solar-suitability-map-2/blob/main/website/src/App.jsx): app shell · Top-level React entry and shared layout for the public site. · `website/src/App.jsx` - [Public pages](https://github.com/kamrul28890/indot-solar-suitability-map-2/tree/main/website/src/routes): route set · Home, map, insights, criteria, data, FAQ, about, contact, and legal pages. · `website/src/routes` - [Shared UI](https://github.com/kamrul28890/indot-solar-suitability-map-2/tree/main/website/src/components): components · Reusable headers, cards, layout primitives, and site chrome. · `website/src/components` - [Map experience](https://github.com/kamrul28890/indot-solar-suitability-map-2/tree/main/website/src/map): gis ui · Interactive map, filters, legends, detail panels, and score presentation. · `website/src/map` - [Insights views](https://github.com/kamrul28890/indot-solar-suitability-map-2/tree/main/website/src/routes/Insights): analysis ui · Charts and summary pages for distributions, comparisons, and reporting. · `website/src/routes/Insights` - [Charts](https://github.com/kamrul28890/indot-solar-suitability-map-2/tree/main/website/src/components/charts): visualization components · Reusable chart primitives used by insights and summary screens. · `website/src/components/charts` - [Map state](https://github.com/kamrul28890/indot-solar-suitability-map-2/tree/main/website/src/utils): map utilities · Filtering, selection, search, statistics, and distance helpers for map interactions. · `website/src/utils` ### Map Builder Maintainer workflow for importing shapefiles and exporting update packages. - [Builder flow](https://github.com/kamrul28890/indot-solar-suitability-map-2/tree/main/website/src/builder/steps): maintainer workflow · Upload, edit, and preview flow for updating site data. · `website/src/builder/steps` - [Builder core](https://github.com/kamrul28890/indot-solar-suitability-map-2/tree/main/website/src/builder/lib): data pipeline · Parsing, geometry repair, normalization, validation, and package creation. · `website/src/builder/lib` - [Schema rules](https://github.com/kamrul28890/indot-solar-suitability-map-2/blob/main/website/src/builder/config/schema.js): validation schema · Rules and shape expectations used by the builder validation layer. · `website/src/builder/config/schema.js` - [Update ZIP](https://github.com/kamrul28890/indot-solar-suitability-map-2/blob/main/website/src/builder/lib/buildPackage.js): export package · Drop-in package containing refreshed manifest and processed GeoJSON assets. · `website/src/builder/lib/buildPackage.js` ### Build & deploy Static build, release packaging, and GitHub Actions deployment. - [Build pipeline](https://github.com/kamrul28890/indot-solar-suitability-map-2/blob/main/website/vite.config.js): vite release · Static site build, release preparation, and packaging scripts. · `website/vite.config.js` - [Deploy actions](https://github.com/kamrul28890/indot-solar-suitability-map-2/blob/main/.github/workflows/deploy-public-site.yml): ci/cd · GitHub Actions workflows that publish the public site. · `.github/workflows/deploy-public-site.yml` - [Public hosting](https://github.com/kamrul28890/indot-solar-suitability-map-2/tree/main/website/public_site): static site · Built site output and public pages deployment target. · `website/public_site` ### Archive Retired prototypes and legacy editor implementations. - [Legacy editor](https://github.com/kamrul28890/indot-solar-suitability-map-2/tree/main/archive/phase2_editor): archive app · Older backend/frontend editor implementations kept for reference. · `archive/phase2_editor` ## Connections - Processed data → Data hook: loads · The hook reads the deployed manifest and layer assets. - Data hook → Site shell: feeds · Loaded data becomes application state for the site shell. - Site shell → Public pages: renders · Top-level navigation and routing mount the public pages. - Site shell → Shared UI: composes · Shared chrome and layout primitives are reused across pages. - Public pages → Map experience: hosts · The map route is the central public browsing experience. - Public pages → Insights views: hosts · Insights pages present analysis built from the same data set. - Insights views → Charts: uses · Insights screens rely on reusable chart components. - Map experience → Map state: depends on · Interactive map behavior is driven by shared state and utility functions. - Map experience → Shared UI: uses · Map screens reuse site-level UI primitives and panels. - Builder flow → Builder core: drives · The maintainer workflow is powered by the builder pipeline. - Builder core → Schema rules: validates against · Normalization and export are constrained by schema rules. - Builder core → Update ZIP: creates · The pipeline assembles the drop-in ZIP update package. - Update ZIP → Processed data: replaces · Exported package updates the processed data assets consumed by the site. - Build pipeline → Public hosting: produces · Vite and release scripts generate the deployable static site. - Deploy actions → Public hosting: publishes · GitHub Actions deploy the built site to the public hosting target. - Legacy editor → Builder core: precedes · Archived editor implementations show the earlier more serverful workflow.