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: about 1 month 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 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-02T17:36:53.000Z (about 2 months ago)
• Last Synced: 2024-10-03T12:17:26.307Z (about 2 months 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

        
# Maps

UK Ordance Survey maps, supporting multiple styles and points of interest. By default, visiting https://www.destructuring-bind.org/maps/ will center on Ambleside (for no particular reason). If you want to start (or sniff around) at a particular town or postcode, add it to the URL, e.g. https://www.destructuring-bind.org/maps/Nottingham or https://www.destructuring-bind.org/maps/PH1+1BD

![maps-leisure](./doc/screenshots/maps_leisure.webp)

![maps-roads](./doc/screenshots/maps_roads.webp)

## Runing it locally

Create an `.env` file in the root folder, with the following keys:

```env

REACT_APP_OS_DATAHUB_API_KEY=

REACT_APP_GEOGRAPH_API_KEY=

```

You will need to sign up for accounts on the [OS DataHub](https://osdatahub.os.uk/)

and [Geograph UK](https://www.geograph.org.uk/) and obtain API keys. 

Then `yarn install` to pull in all the dependencies, while `yarn start` will run the app

in development mode. Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits. You will also see any lint errors

in the console.

## Hosting yourself

Fork the repo, and Github actions will/should deploy the app to Github pages. You will almost

certainly have to manually edit your settings to deploy from the `gh-pages` branch:

![github-pages](./doc/screenshots/github_pages.webp)

And then, create secrets from the API keys:

![github-secrets](./doc/screenshots/github_secrets.webp)

## MIT License

Copyright (c) 2021 Richard Hull

Permission is hereby granted, free of charge, to any person obtaining a copy

of this software and associated documentation files (the "Software"), to deal

in the Software without restriction, including without limitation the rights

to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the Software is

furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all

copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

SOFTWARE.