https://github.com/rm-hull/maps
UK Ordance Survey maps, supporting multiple styles and points of interest.
https://github.com/rm-hull/maps
github-pages mapping ordnance-survey react typescript uk
Last synced: 18 days ago
JSON representation
UK Ordance Survey maps, supporting multiple styles and points of interest.
- Host: GitHub
- URL: https://github.com/rm-hull/maps
- Owner: rm-hull
- License: mit
- Created: 2023-02-13T20:45:05.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-02T17:36:53.000Z (over 1 year ago)
- Last Synced: 2024-10-03T12:17:26.307Z (over 1 year ago)
- Topics: github-pages, mapping, ordnance-survey, react, typescript, uk
- Language: TypeScript
- Homepage: https://www.destructuring-bind.org/maps/
- Size: 32.9 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# UK Ordnance Survey Maps
This is a web application that displays UK Ordnance Survey (OS) maps, supporting multiple map styles, points of interest, and GPS track integration.
- **Live Site:** https://www.destructuring-bind.org/maps/
By default, the map will center on Ambleside. You can specify a starting location by adding a town name or postcode to the URL, for example:
- https://www.destructuring-bind.org/maps/Nottingham
- https://www.destructuring-bind.org/maps/PH1+1BD
_Leisure Map Style_
_Roads Map Style_
## Features
* **Multiple Map Styles:** Switch between different OS map styles, including Leisure and Roads.
* **Location Search:** Search for towns and postcodes across the UK.
* **Points of Interest:** Display photos from [Geograph](https://www.geograph.org.uk/) as points of interest on the map.
* **GPS Tracking:** Show your current location on the map.
* **GPS Route Display:** Load and display GPS tracks from GPX and KML files.
* **Measurement Tool:** Measure distances on the map.
## Key Technologies
* **Framework:** React
* **Language:** TypeScript
* **Build Tool:** Vite
* **Mapping:** Leaflet.js, React-Leaflet, maplibre-gl
* **UI:** Chakra UI
* **State Management:** Jotai
* **Data Fetching:** React Query
## Running Locally
To run the application locally, follow these steps:
1. **Clone the repository:**
```bash
git clone https://github.com/r-hull/maps.git
cd maps
```
2. **Create an environment file:**
Create a `.env` file in the root of the project with the following content:
```env
VITE_OS_DATAHUB_API_KEY=
VITE_GEOGRAPH_API_KEY=
```
You will need to sign up for free accounts on the [OS DataHub](https://osdatahub.os.uk/) and [Geograph UK](https://www.geograph.org.uk/) to obtain these API keys.
3. **Install dependencies:**
```bash
yarn install
```
4. **Run the development server:**
```bash
yarn dev
```
The application will be available at http://localhost:5173 (or the next available port).
## Hosting Yourself
This project includes a GitHub Actions workflow to automatically deploy the application to GitHub Pages.
1. **Fork the repository.**
2. **Enable GitHub Pages:** In your repository settings, under "Pages", set the source to "GitHub Actions".
3. **Create repository secrets:** In your repository settings, under "Secrets and variables" > "Actions", create the following secrets:
* `VITE_OS_DATAHUB_API_KEY`: Your OS Datahub API key.
* `VITE_GEOGRAPH_API_KEY`: Your Geograph API key.
The workflow will then build and deploy the application automatically.
## Attribution
* Leaflet marker icons sourced from [pointhi/leaflet-color-markers](https://github.com/pointhi/leaflet-color-markers).
## License
This project is licensed under the MIT License. See the [LICENSE.md](LICENSE.md) file for details.