https://github.com/mfbx9da4/brightpath-backend
Find the safest well lit walking path between two locations on earth.
https://github.com/mfbx9da4/brightpath-backend
astar-algorithm djikstra-algorithm osm routing-algorithm
Last synced: 3 months ago
JSON representation
Find the safest well lit walking path between two locations on earth.
- Host: GitHub
- URL: https://github.com/mfbx9da4/brightpath-backend
- Owner: mfbx9da4
- Created: 2019-10-04T23:37:09.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-10T04:37:20.000Z (about 2 years ago)
- Last Synced: 2024-11-05T01:34:50.585Z (4 months ago)
- Topics: astar-algorithm, djikstra-algorithm, osm, routing-algorithm
- Language: Go
- Homepage: https://brightpath-fe.web.app
- Size: 19.2 MB
- Stars: 123
- Watchers: 3
- Forks: 9
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Brightpath
## Demo
### Using the demo
- [Demo can be found here](https://brightpath-fe.web.app)
- Click two points anywhere on the map of London.
- The animation between points is just an animation, the response from the server is instant.
- Limited to London due to memory constraints of the free tier of heroku.
- Your live location will be updated regularly if you are walking or cycling.
[
](https://brightpath-fe.web.app)[
](https://brightpath-fe.web.app)
## Mission
To provide the safest well lit walking route between two locations.
## Problem
- Google maps can often provide unsafe walking routes.
- If you are new to a city or travelling you are highly dependent on google maps for navigating safely between locations and you will often be on foot.
- There has been a surge of people vying for a product which provides safe walking paths. Here are some [examples](https://twitter.com/Chlojob_/status/1181279485901099008?s=19) from twitter.
## Blogs
These were written as a follow up to the hackathon about our experience.
- [Building an Algorithm to Find the Safest Route Home, (David)](https://www.crowdform.co.uk/blog/how-to-lead-people-home-safer-with-routing-algorithms)
- [My first Hackathon as a UX/UI Designer, (Aristos)](https://medium.com/@aristos.michaelides/my-first-hackathon-as-a-ux-ui-designer-d7fbd7c34602)
- [Route finder app in Golang, (Quynh)](https://medium.com/@dataqween/route-finder-app-100-days-of-golang-day-10-20-bb5f61e21535)
- [LinkedIn post, (Aristos)](https://www.linkedin.com/posts/aristos-michaelides-0639b593_last-weekend-i-participated-in-the-global-activity-6584769414229557248-rPaP/)
## Presentation
[Presentation slides can be found here](https://docs.google.com/presentation/d/e/2PACX-1vQI5T6knTUv9CPph-cnrhaS_v2JavzzSXZUsJ3H7ZK7uYJaJCTFg4jkwZA7ZjEFGw/pub?start=false&loop=false&delayms=3000)
[
](https://docs.google.com/presentation/d/e/2PACX-1vQI5T6knTUv9CPph-cnrhaS_v2JavzzSXZUsJ3H7ZK7uYJaJCTFg4jkwZA7ZjEFGw/pub?start=false&loop=false&delayms=3000)
## Solution
Brightpath finds walking routes through the city that are well lit, avoiding dark pathways. Later we could incorporate many other kinds of data such as safe checkpoints trivially. The core technical challenge was wrangling the data and writing our own custom routing algorithm. For this hackathon we used data about whether a street is lit or not from [Open Street Map](<[https://www.openstreetmap.org/#map=10/51.4835/-0.1265](https://www.openstreetmap.org/#map=10/51.4835/-0.1265)>). Later we could incorporate official [UK gov data about street lighting](https://data.gov.uk/search?q=Street+Light) or even incorporate satellite imaging data.
[To test the routing algorithm in the wild, click any two locations on the map of London.](https://brightpath-fe.web.app) Note this is limited to London because of the limitations of heroku free plan. While we did optimize for space complexity there are over 5 million edges in London.
### Our approach
Our MVP has focused on using brightness as an objective measure for how safe one might feel. As a society we all need to be more conscious and critical of apps that ‘think for us’, and the data they use. Other ‘objective’ metrics we considered for the future include shop density, heat maps and traffic. We strive to give the power back to the user and allow them to select the safety metrics which are right for them.
## Source code
### Backend
[Backend github repository](https://github.com/mfbx9da4/brightpath-backend). Built in Go, hosted on heroku. https://brightpath.herokuapp.com
Steps taken to create backend
1. Get a dump of London data from Open Street Map
2. Convert OSM format to geojson.
3. [Clean geojson](https://github.com/mfbx9da4/brightpath-backend/blob/master/geojson-cleaner/geojson-cleaner.go) to remove dark pathways.
4. [Write algorithm](https://github.com/mfbx9da4/brightpath-backend/blob/master/parse-geojson.go#L43) to load geojson into graph representation in memory in Go.
5. Create Go API server.
6. Write algorithm for [finding closest known](https://github.com/mfbx9da4/brightpath-backend/blob/master/graph.go#L136) node to user requested start and end coordinates.
7. Write [A\* routing algorithm](https://github.com/mfbx9da4/brightpath-backend/blob/master/graph.go#L164) to find shortest path between two nodes in optimal time.
8. Write [unit tests](https://github.com/mfbx9da4/brightpath-backend/blob/master/routing_test.go) and test cases for shortest path edge cases.
### Frontend 1
- [Frontend 1 github repository](https://github.com/mfbx9da4/brightpath-frontend)
- [Hosted on firebase](https://brightpath-fe.web.app).
- Written in Vanilla JS.
- Originally written for testing purposes.
- Uses mapbox for map.
- Connects to backend hosted on [heroku](https://brightpath.herokuapp.com/).
### Frontend 2
- [Frontend 2 github repository](https://github.com/river-honer/lightpath)
- Uses vuejs
- Uses mapbox geolocation API to get start and end destination.
- Uses leaflet to render map.
- Connects to backend hosted on [heroku](https://brightpath.herokuapp.com/)
## Design Proposal
We put together some [high fidelity mockups](https://www.behance.net/gallery/86223243/BrightPath-Safe-route-finder) of what the app could look like later on.
## How it relates to Accessibility and Community
- Our solution is especially useful for those who are travelling and are not familiar with their new surroundings and therefore highly dependent on navigation apps.
- Our solution makes travel more accessible for everyone. We made sure to inlcude minorities which are often overlooked. Our solution does not discriminate - it is for anyone that does not currently feel safe enough to go out at night (whether they are in a different continent, country, city or even an area they are not used to). These can be individuals with ‘protected characteristics’ under the Equality Act (such as those that are disabled such as partially visually impaired, those with visible differences (such as ethnic minorities or gender) and invisible differences (such as LGBQT+)), but it can also be for any one else that feels vulnerable.
- Our solution also empowers users to engage more with the local community. For example, from our research there are a number of travellers who will ‘go out at night’, however they will use taxis to get from A to B because they do not feel safe to walk from the hotel to the venue (and/or back again). I’m sure we all have stories of having some of the best nights when wander freely around a local area, meeting locals serendipitously. Our app gives more people the opportunity to have impromptu connections with the local community, in more locations.
## Run Backend
```
go build -v -o bin/main . && ./bin/main
```
## Run Frontend
```
yarn install
yarn start
```