Skip to content

Commit 79dbbf4

Browse files
authored
Update README.md
Added details about features & project architecture
1 parent 57bd76b commit 79dbbf4

File tree

1 file changed

+37
-2
lines changed

1 file changed

+37
-2
lines changed

README.md

Lines changed: 37 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
<!-- PROJECT LOGO & DESCRIPTION -->
2-
31
<div align="center">
42
<h1>Map Dashboard Web Application</h1>
53
<p>
@@ -60,6 +58,43 @@ We use Vitest for testing, which has a hot reloading feature. This means you can
6058
pnpm test
6159
```
6260

61+
62+
# Features & Implementation Details
63+
64+
6365
## Important Links
6466

6567
This project currently uses Tableau to format geospatial input data. Tableau has an extensive library of [tutorials](https://www.tableau.com/resources) and [API documentation](https://www.tableau.com/developer/tools?category=19921).
68+
69+
70+
## Features
71+
72+
The Map Dashboard will display 3 types of map data:
73+
1. Base map using our data from Notion
74+
2. Water department polygons showing water volume (gradient of blue shades)
75+
3. Canopy density (using transparency layer or classified zones; gradient of green shades)
76+
77+
There are 2 types of map marker pins; pins can be grouped or clustered:
78+
1. Plants: green pins
79+
2. Animals: red pins
80+
81+
Users can hover over marker pins and map data to view a tooltip that displays any of the following information:
82+
1. Name of the animal or plant
83+
2. Water volume
84+
3. Canopy cover
85+
86+
Users can filter the map by:
87+
- Animal vs plant
88+
- Water volume
89+
- Canopy density
90+
91+
## Architecture
92+
93+
| Component | Technology |
94+
|---------------------|------------------------------------------------|
95+
| Notion Database | Notion API |
96+
| PostgresSQL Storage | Postgres + Post GIS (optiona) |
97+
| Visualization | Tableau (Desktop/Server/Cloud) |
98+
| Automation | GitHub Actions, Cron jobs |
99+
| Water Data | Shapefiles/CSVs into Postgres |
100+
| Canopy Data | Meta Canopy Map GeoTIFF/GeoJSON |

0 commit comments

Comments
 (0)