H3 Hexagon Mapper

This project is a web tool that helps you see and interact with H3 hexagons on a map. You can add or remove hexagons, change their size, color, and transparency, add or remove markers, and save or load everything as a GeoJSON file.

Online Tool

You can access the online tool here.

Libraries Used

• Leaflet: A JavaScript library for interactive maps. License: BSD 2-Clause "Simplified" License
• H3-js: A JavaScript library for working with H3 hexagons. License: Apache License 2.0
• OpenStreetMap: Used for map tiles. License: Open Data Commons Open Database License (ODbL)
• Tailwind CSS: A utility-first CSS framework for rapid UI development. License: MIT License

How to Use it

• Add a Hexagon: Click on the map to add a hexagon at the clicked location.
• Remove a Hexagon: Click on an existing hexagon to remove it. Ensure the resolution of the hexagon matches the resolution slider value.
• Add a Marker: Right-click on the map to open a popup where you can enter a marker name and add it to the map.
• Remove a Marker: Right-click on an existing marker to remove it.
• Adjust Hexagon Resolution: Use the resolution slider in the controls section to adjust the resolution of the hexagons.
• Change Hexagon Color: Use the color picker in the controls section to change the color of the hexagons.
• Change Hexagon Opacity: Use the opacity slider in the controls section to adjust the opacity of the hexagons.
• Save Hexagons and Markers: Click the "Save" button to download the current hexagons and markers as a GeoJSON file.
• Load Hexagons and Markers: Click the "Load" button and select a GeoJSON file to load hexagons and markers from the file.

How to Run Locally

To run the project locally, follow these steps:

1. Clone the repository:

   git clone https://github.com/ivangfr/h3-hexagon-mapper.git

2. Navigate to the project directory:

   cd h3-hexagon-mapper

3. Open the index.html file in your web browser:

   open index.html

Contributing

Contributions are welcome! If you have any ideas, suggestions, or bug reports, please open an issue or submit a pull request.

License

This project is licensed under the BSD 3-Clause License. See the LICENSE file for details.