Add binoculars theme, auto reformat everything
This commit is contained in:
parent
38dea806c5
commit
78d6482c88
586 changed files with 115573 additions and 111842 deletions
105
README.md
105
README.md
|
|
@ -1,10 +1,12 @@
|
|||
|
||||
# MapComplete
|
||||
|
||||
> Let a thousand flowers bloom
|
||||
|
||||
MapComplete is an OpenStreetMap viewer and editor. It shows map features on a certain topic, and allows to see, edit and add new features to the map.
|
||||
It can be seen as a webversion [crossover of StreetComplete and MapContrib](Docs/MapComplete_vs_other_editors.md). It tries to be just as easy to use as StreetComplete, but it allows to focus on one single theme per instance (e.g. nature, bicycle infrastructure, ...)
|
||||
MapComplete is an OpenStreetMap viewer and editor. It shows map features on a certain topic, and allows to see, edit and
|
||||
add new features to the map. It can be seen as a
|
||||
webversion [crossover of StreetComplete and MapContrib](Docs/MapComplete_vs_other_editors.md). It tries to be just as
|
||||
easy to use as StreetComplete, but it allows to focus on one single theme per instance (e.g. nature, bicycle
|
||||
infrastructure, ...)
|
||||
|
||||
The design goals of MapComplete are to be:
|
||||
|
||||
|
|
@ -13,29 +15,39 @@ The design goals of MapComplete are to be:
|
|||
- Easy to set up a custom theme
|
||||
- Easy to fall down the rabbit hole of OSM
|
||||
|
||||
The basic functionality is to download some map features from Overpass and then ask certain questions. An answer is sent back to directly to OpenStreetMap.
|
||||
The basic functionality is to download some map features from Overpass and then ask certain questions. An answer is sent
|
||||
back to directly to OpenStreetMap.
|
||||
|
||||
Furthermore, it shows images present in the `image` tag or, if a `wikidata` or `wikimedia_commons`-tag is present, it follows those to get these images too.
|
||||
|
||||
An explicit non-goal of MapComplete is to modify geometries of ways. Although adding a point to a way or splitting a way in two parts might be added one day.
|
||||
Furthermore, it shows images present in the `image` tag or, if a `wikidata` or `wikimedia_commons`-tag is present, it
|
||||
follows those to get these images too.
|
||||
|
||||
An explicit non-goal of MapComplete is to modify geometries of ways. Although adding a point to a way or splitting a way
|
||||
in two parts might be added one day.
|
||||
|
||||
# Creating your own theme
|
||||
|
||||
It is possible to quickly make and distribute your own theme - [please read the documentation on how to do this](Docs/Making_Your_Own_Theme.md).
|
||||
It is possible to quickly make and distribute your own theme
|
||||
- [please read the documentation on how to do this](Docs/Making_Your_Own_Theme.md).
|
||||
|
||||
## Examples
|
||||
|
||||
- [Buurtnatuur.be](http://buurtnatuur.be), developed for the Belgian [Green party](https://www.groen.be/). They also funded the initial development!
|
||||
- [Cyclofix](https://pietervdvn.github.io/MapComplete/index.html?layout=cyclofix), further development on [Open Summer of Code](https://summerofcode.be/) funded by [Brussels Mobility](https://mobilite-mobiliteit.brussels/en). Landing page at https://cyclofix.osm.be/
|
||||
- [Bookcases](https://pietervdvn.github.io/MapComplete/index.html?quests=bookcases#element) cause I like to collect them.
|
||||
- [Map of Maps](https://pietervdvn.github.io/MapComplete/index.html?layout=maps&z=14&lat=50.650&lon=4.2668#element), after a tweet
|
||||
- [Buurtnatuur.be](http://buurtnatuur.be), developed for the Belgian [Green party](https://www.groen.be/). They also
|
||||
funded the initial development!
|
||||
- [Cyclofix](https://pietervdvn.github.io/MapComplete/index.html?layout=cyclofix), further development
|
||||
on [Open Summer of Code](https://summerofcode.be/) funded
|
||||
by [Brussels Mobility](https://mobilite-mobiliteit.brussels/en). Landing page at https://cyclofix.osm.be/
|
||||
- [Bookcases](https://pietervdvn.github.io/MapComplete/index.html?quests=bookcases#element) cause I like to collect
|
||||
them.
|
||||
- [Map of Maps](https://pietervdvn.github.io/MapComplete/index.html?layout=maps&z=14&lat=50.650&lon=4.2668#element),
|
||||
after a tweet
|
||||
|
||||
There are plenty more. Discover them in the app.
|
||||
|
||||
### Statistics
|
||||
|
||||
To see statistics, consult [OsmCha](https://osmcha.org/?filters=%7B%22comment%22%3A%5B%7B%22label%22%3A%22%23mapcomplete%22%2C%22value%22%3A%22%23mapcomplete%22%7D%5D%2C%22date__gte%22%3A%5B%7B%22label%22%3A%222020-07-05%22%2C%22value%22%3A%222020-07-05%22%7D%5D%7D) or the [analytics page](https://pietervdvn.goatcounter.com/)
|
||||
To see statistics,
|
||||
consult [OsmCha](https://osmcha.org/?filters=%7B%22comment%22%3A%5B%7B%22label%22%3A%22%23mapcomplete%22%2C%22value%22%3A%22%23mapcomplete%22%7D%5D%2C%22date__gte%22%3A%5B%7B%22label%22%3A%222020-07-05%22%2C%22value%22%3A%222020-07-05%22%7D%5D%7D)
|
||||
or the [analytics page](https://pietervdvn.goatcounter.com/)
|
||||
|
||||
## User journey
|
||||
|
||||
|
|
@ -48,59 +60,68 @@ A typical user journey would be:
|
|||
* The user might discover the explanation about OSM in the second tab
|
||||
* The user might share the map and/or embed it in the third tab
|
||||
* The user might discover the other themes in the last tab
|
||||
|
||||
1. The user clicks that big tempting button 'login' in order to answer questions - there's enough of these login buttons... The user creates an account.
|
||||
|
||||
1. The user clicks that big tempting button 'login' in order to answer questions - there's enough of these login
|
||||
buttons... The user creates an account.
|
||||
|
||||
2. The user answers a question! Hooray! The user transformed into a __contributor__ now.
|
||||
|
||||
|
||||
* When at least one question is answered (aka: having one changeset on OSM), adding a new point is unlocked
|
||||
|
||||
|
||||
3. The user adds a new POI somewhere
|
||||
|
||||
* Note that _all messages_ must be read before being able to add a point.
|
||||
* In other words, sending a message to a misbehaving MapComplete user acts as having a **zero-day-block**. This is added deliberately to make sure new users _have_ to read feedback from the community.
|
||||
|
||||
4. At 50 changesets, the [personal layout](https://pietervdvn.github.io/MapComplete/personal.html) is advertised. The personal theme is a theme where contributors can pick layers from all the official themes. Note that the personal theme is always available.
|
||||
* In other words, sending a message to a misbehaving MapComplete user acts as having a **zero-day-block**. This is
|
||||
added deliberately to make sure new users _have_ to read feedback from the community.
|
||||
|
||||
5. At 200 changesets, the tags become visible when answering questions and when adding a new point from a preset. This is to give more control to power users and to teach new users the tagging scheme
|
||||
4. At 50 changesets, the [personal layout](https://pietervdvn.github.io/MapComplete/personal.html) is advertised. The
|
||||
personal theme is a theme where contributors can pick layers from all the official themes. Note that the personal
|
||||
theme is always available.
|
||||
|
||||
5. At 200 changesets, the tags become visible when answering questions and when adding a new point from a preset. This
|
||||
is to give more control to power users and to teach new users the tagging scheme
|
||||
|
||||
6. At 250 changesets, the tags get linked to the wiki
|
||||
|
||||
7. At 500 changesets, I expect contributors to be power users and to be comfortable with tagging scheme and such. The custom theme generator is unlocked.
|
||||
|
||||
7. At 500 changesets, I expect contributors to be power users and to be comfortable with tagging scheme and such. The
|
||||
custom theme generator is unlocked.
|
||||
|
||||
## License
|
||||
|
||||
GPLv3.0 + recommended pingback.
|
||||
|
||||
I love it to see where the project ends up. You are free to reuse the software (under GPL) but, when you have made your own change and are using it, I would like to know about it. Drop me a line, give a pingback in the issues,...
|
||||
I love it to see where the project ends up. You are free to reuse the software (under GPL) but, when you have made your
|
||||
own change and are using it, I would like to know about it. Drop me a line, give a pingback in the issues,...
|
||||
|
||||
## Dev
|
||||
|
||||
To develop or deploy a version of MapComplete, have a look [to the guide](Docs/Development_deployment.md).
|
||||
|
||||
|
||||
## Translating MapComplete
|
||||
|
||||
The core strings and builtin themes of MapComplete are translated on [Hosted Weblate](https://hosted.weblate.org/projects/mapcomplete/core/).
|
||||
You can easily make an account and start translating in their web-environment - no installation required.
|
||||
The core strings and builtin themes of MapComplete are translated
|
||||
on [Hosted Weblate](https://hosted.weblate.org/projects/mapcomplete/core/). You can easily make an account and start
|
||||
translating in their web-environment - no installation required.
|
||||
|
||||
[](https://hosted.weblate.org/engage/mapcomplete/)
|
||||
|
||||
|
||||
## Architecture
|
||||
|
||||
### High-level overview
|
||||
|
||||
The website is purely static. This means that there is no database here, nor one is needed as all the data is kept in OpenStreetMap, Wikimedia (for images), Imgur. Settings are saved in the preferences-space of the OSM-website, amended by some local-storage if the user is not logged-in.
|
||||
The website is purely static. This means that there is no database here, nor one is needed as all the data is kept in
|
||||
OpenStreetMap, Wikimedia (for images), Imgur. Settings are saved in the preferences-space of the OSM-website, amended by
|
||||
some local-storage if the user is not logged-in.
|
||||
|
||||
When viewing, the data is loaded from overpass. The data is then converted (in the browser) to geojson, which is rendered by Leaflet.
|
||||
When viewing, the data is loaded from overpass. The data is then converted (in the browser) to geojson, which is
|
||||
rendered by Leaflet.
|
||||
|
||||
When a map feature is clicked, a popup shows the information, images and questions that are relevant for that object.
|
||||
The answers given by the user are sent (after a few seconds) to OpenStreetMap directly - if the user is logged in. If not logged in, the user is prompted to do so.
|
||||
|
||||
The UI-event-source is a class where the entire system is built upon, it acts as an observable object: another object can register for changes to update when needed.
|
||||
The answers given by the user are sent (after a few seconds) to OpenStreetMap directly - if the user is logged in. If
|
||||
not logged in, the user is prompted to do so.
|
||||
|
||||
The UI-event-source is a class where the entire system is built upon, it acts as an observable object: another object
|
||||
can register for changes to update when needed.
|
||||
|
||||
### Searching images
|
||||
|
||||
|
|
@ -114,15 +135,19 @@ Images are fetched from:
|
|||
|
||||
Images are uploaded to Imgur, as their API was way easier to handle. The URL is written into the changes.
|
||||
|
||||
The idea is that once in a while, the images are transferred to wikipedia or that we hook up wikimedia directly (but I need some help in getting their API working).
|
||||
The idea is that once in a while, the images are transferred to wikipedia or that we hook up wikimedia directly (but I
|
||||
need some help in getting their API working).
|
||||
|
||||
### Uploading changes
|
||||
|
||||
In order to avoid lots of small changesets, a changeset is opened and kept open. The changeset number is saved into the users preferences on OSM.
|
||||
In order to avoid lots of small changesets, a changeset is opened and kept open. The changeset number is saved into the
|
||||
users preferences on OSM.
|
||||
|
||||
Whenever a change is made -even adding a single tag - the change is uploaded into this changeset. If that fails, the changeset is probably closed and we open a new changeset.
|
||||
Whenever a change is made -even adding a single tag - the change is uploaded into this changeset. If that fails, the
|
||||
changeset is probably closed and we open a new changeset.
|
||||
|
||||
Note that changesets are closed automatically after one hour of inactivity, so we don't have to worry about closing them.
|
||||
Note that changesets are closed automatically after one hour of inactivity, so we don't have to worry about closing
|
||||
them.
|
||||
|
||||
# Documentation
|
||||
|
||||
|
|
@ -130,13 +155,11 @@ All documentation can be found in [here](Docs/)
|
|||
|
||||
# Privacy
|
||||
|
||||
Privacy is important, we try to leak as little information as possible.
|
||||
All major personal information is handled by OSM.
|
||||
Geolocation is available on mobile only through the device's GPS location (so no geolocation is sent of to Google).
|
||||
Privacy is important, we try to leak as little information as possible. All major personal information is handled by
|
||||
OSM. Geolocation is available on mobile only through the device's GPS location (so no geolocation is sent of to Google).
|
||||
|
||||
TODO: erase cookies of third party websites and API's
|
||||
|
||||
|
||||
# Attribution and Copyright
|
||||
|
||||
The code is available under GPL; all map data comes from OpenStreetMap (both foreground and background maps).
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue