Go to file
Midgard 6cf0ca9fb6
Recognize fire_hydrant:position=cycleway but don't ask question
2021-06-06 18:33:32 +02:00
.github Experimenting with GH Actions 2021-04-11 03:17:59 +02:00
Customizations Add LayerIndex convenience function 2021-04-25 13:23:27 +02:00
Docs Remove console.trace 2021-04-26 21:10:34 +02:00
Logic Fix issues with camera rotation 2021-04-28 17:21:06 +02:00
Models Only show woonerf-explantion on living-streets 2021-04-25 22:16:11 +02:00
UI Small fixes 2021-04-23 17:22:01 +02:00
assets Recognize fire_hydrant:position=cycleway but don't ask question 2021-06-06 18:33:32 +02:00
css Cleanup of review-css to use tailwind 2021-03-13 19:07:38 +01:00
scripts Version bump 2021-04-25 14:20:14 +02:00
static Added cyclofix capacity cargo; covered; non-bike shop; pump dyn title 2020-07-29 13:16:21 +02:00
test Add capability to load tiled geojsons, eventually as overpass-cache 2021-04-22 03:30:46 +02:00
vendor Add working clustering! 2021-01-04 18:55:10 +01:00
.gitignore Small fixes 2021-04-23 17:22:01 +02:00
.tool-versions Create .tool-versions 2021-01-17 20:59:21 +01:00
AllTranslationAssets.ts Add new graphs 2021-04-25 12:08:27 +02:00
Folder.DotSettings.user Formatting and small cleanups 2021-03-29 02:53:06 +02:00
InitUiElements.ts Documentation improvement and warning cleanup 2021-04-25 16:01:46 +02:00
LICENSE Small fixes for the GRB theme and value substitution 2020-08-27 00:08:00 +02:00
README.md assorted README fixes - typos etc 2021-04-23 09:57:10 +02:00
State.ts Add feature which loads the selected element from overpass to update the tags to the latest version 2021-04-21 01:26:13 +02:00
Svg.ts Styling tweaks for speelplekken theme 2021-04-23 12:59:09 +02:00
Utils.ts Add capability to load tiled geojsons, eventually as overpass-cache 2021-04-22 03:30:46 +02:00
apple_touch_icon.png Add apple touch icons, fix for #223 2021-03-17 14:17:33 +01:00
customGenerator.html Small improvements to the custom theme generator 2021-03-23 13:51:34 +01:00
customGenerator.ts Fix loading of compressed themes in the custom generator too 2021-04-11 23:43:23 +02:00
generated.license_info.json Work on fire hydrants layer 2021-05-01 14:28:55 +02:00
index.css Small refactoring, add 'last edit by'-rendering 2021-04-21 01:26:36 +02:00
index.html Visualize attribution in the attribution panel 2021-04-09 02:57:06 +02:00
index.manifest New manifest for index page (generated) 2021-03-09 13:11:41 +01:00
index.ts Merge master 2021-04-22 03:54:14 +02:00
land.html Add MapComplete 2020-06-24 00:35:19 +02:00
manifest.manifest Fix manifest a bit 2021-02-20 22:27:19 +01:00
package-lock.json Only show woonerf-explantion on living-streets 2021-04-25 22:16:11 +02:00
package.json Only show woonerf-explantion on living-streets 2021-04-25 22:16:11 +02:00
postcss.config.js Add TailwindCSS 2021-01-17 21:01:44 +01:00
preferences.html Add the possibility to load a custom layout with base64-encoded jsons 2020-08-08 17:50:43 +02:00
preferences.ts More validation and fixes 2021-04-10 03:50:44 +02:00
run.bat Spanish translation 2020-08-26 01:03:51 +02:00
tailwind.config.js Fix landscape mode 2021-01-27 02:26:57 +01:00
test.html Styling tweaks for speelplekken theme 2021-04-23 12:59:09 +02:00
test.ts Add tests in iframe, fix loading in iframes 2021-02-21 01:57:50 +01:00
tsconfig.json Fix deployment 2021-02-15 17:44:19 +01:00
tslint.json Update documentation 2021-04-10 13:41:45 +02:00

README.md

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. 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:

  • Easy to use, both on web and on mobile
  • Easy to deploy (by not having a backend)
  • 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.

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.

Examples

There are plenty more. Discover them in the app.

Statistics

To see statistics, consult OsmCha or the analytics page

User journey

MapComplete is set up to lure people into OpenStreetMap and to teach them while they are on the go, step by step.

A typical user journey would be:

  1. Oh, this is a cool map of my specific interest! There is a lot of data already...

    • 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
  2. 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.

  3. 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
  4. 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.
  5. At 50 changesets, the personal layout is advertised. The personal theme is a theme where contributors can pick layers from all the offical themes. Note that the personal theme is always available.

  6. 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

  7. At 250 changesets, the tags get linked to the wiki

  8. 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,...

Dev

To develop:

  1. Make sure you have a recent version of nodejs - at least 12.0, preferably 15
  2. Make a fork and clone the repository.
  3. Install npm. Linux: sudo apt install npm (or your favourite package manager), Windows: install nodeJS: https://nodejs.org/en/download/
  4. Run npm install to install the package dependencies
  5. Run npm run generate and npm run generate:editor-layer-index to generate some additional dependencies
  6. Run npm run start to host a local testversion at http://localhost:1234/index.html
  7. By default, the 'bookcases'-theme is loaded. In order to load another theme, use layout=themename or userlayout=true#<layout configuration>. Note that the custom URLs (e.g. bookcases.html, aed.html, ...) don't exist on the development version. (These are automatically generated from a template on the server).

To deploy:

  1. rm -rf dist/ to remove the local build
  2. npm run build
  3. Copy the entire dist folder to where you host your website. Visiting index.html gives you the website

Translating MapComplete

Help to translate mapcomplete.

A theme has translations into the preset.json (assets/themes/themename/themename.json). To add a translation:

  1. Fork this repository
  2. Modify "language" to contain the new language, e.g. "language": "nl" becomes "language": ["nl", "en"]
  3. Add extra strings to the texts. If it used to be a single-language theme, one can replace the strings, e.g.: "description": "Welcome to Open Bookcase Map" to "description": {"en": "Welcome to Open Bookcase Map", "nl": "Welkom bij de OpenBoekenruilkastenKaart", "fr": "Bienvenue sûr la carte des petites bibliotheques"}. If the correct language is not found, it'll fallback to another supported language.
  4. If you notice missing translations in the core of MapComplete, fork this project, open the file containing all translations, add add a language string there
  5. Send a pull request to update the languages, I'll gladly add it! It doesn't have to be a complete translation from the start ;)

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.

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.

Searching images

Images are fetched from:

  • The OSM image, image:0, image:1, ... tags
  • The OSM wikimedia_commons tags
  • If wikidata is present, the wikidata P18 (image) claim and, if a commons link is present, the commons images

Uploading images

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 transfered 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.

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.

Documentation

All documentation can be found in here

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 throught hte 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).

Background layer selection: curated by https://github.com/osmlab/editor-layer-index

Icons are attributed in various 'license_info.json'-files and can be found in the app.