Skip to content

Commit 74b8231

Browse files
committed
README & Test Fixes
1 parent bd4e28a commit 74b8231

File tree

17 files changed

+51
-14
lines changed

17 files changed

+51
-14
lines changed

README.md

Lines changed: 41 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,55 @@
22

33
A map for everyone, right in the browser.
44

5-
The app is free to use, does not require any registration, no app stores and does not collect any personal data.
5+
The app is free to use: no API keys, no registration, no app stores and no invasions of privacy. Just open Navigator and start exploring.
6+
7+
This project is inspired by, and made possible thanks to the [OpenStreetMap](https://www.openstreetmap.org/) ecosystem. Special thanks to [OpenFreeMap](https://openfreemap.org/) for their tile hosting that makes this project possible.
8+
9+
[«« Use Navigator »»](https://www.ogis.org/navigator/)
10+
11+
## Features
12+
13+
- No install, no account.
14+
- GPS locate with compass heading.
15+
- Once loaded, works offline (cached tiles and data).
16+
- Multilingual (auto-detects browser language).
17+
- Shareable map links.
18+
- OpenStreetMap integration (View/Edit on OSM).
19+
- Map view synced between sessions.
20+
- User preference settings.
21+
- Works on any device.
622

723
## Aims
824

925
- A handy, general purpose mapping tool that anyone can use.
1026
- Offer low barriers to, and promote Open data.
1127
- Tighten the feedback loop between Open data contributors and consumers.
12-
- Be Open
28+
- Be Open.
29+
30+
[![App Preview](assets/screenshots/docs/core/about-panel.png)](https://www.ogis.org/navigator/)
31+
32+
[«« Use Navigator »»](https://www.ogis.org/navigator/)
33+
34+
## Planned Changes
35+
36+
- Worldwide language support.
37+
- Search ([Nominatim](https://nominatim.org/) integration).
38+
- Better handling of denied location permissions.
39+
- Improved offline capabilities ([PWA](https://developer.mozilla.org/docs/Web/Progressive_web_apps) features).
40+
- A developer fiendly plugin system.
41+
- Dark map style.
42+
43+
## Drawbacks and Limitations
44+
45+
I believe the benefits of a web app far outweigh the drawbacks, but it's important to be transparent about the limitations:
46+
47+
- Location permissions are required for GPS/Compass features. Some users have a deny-all approach to web browser permissions and changing permissions varies widely between browsers and devices. _This is a genuine pain point, with not much you can do other than warn and inform the user_
48+
49+
- The app does not work in the background or when the device is locked. _This is a common limitation of web apps, but I want to explore ways to improve this with better caching and PWA features_
1350

14-
[Use Navigator](https://www.ogis.org/navigator/)
51+
- Depending on a single tile provider ([OpenFreeMap](https://openfreemap.org/)) creates a single point of failure. _Their implementation is Open-Source and [self-hosting](https://github.com/hyperknot/openfreemap/blob/main/docs/self_hosting.md) is something I want to persue_
1552

16-
[![App Preview](assets/screenshots/app-preview.png)](https://www.ogis.org/navigator/)
53+
- While the app works well with no internet service, it does require an initial connection to load the app assets and map tiles. _This can be hard to communicate to users and set expectations._
1754

1855
## Thanks Open Source!
1956

assets/screenshots/app-preview.png

151 Bytes
Loading
-768 KB
Loading
-462 Bytes
Loading
-1.36 KB
Loading
-149 Bytes
Loading
523 Bytes
Loading
66 Bytes
Loading
19.2 KB
Loading
-18.9 KB
Loading

0 commit comments

Comments
 (0)