Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Qwant/qwantmaps

Central repository for Qwant Maps resources
https://github.com/Qwant/qwantmaps

geocoder kartotherian osm qwant qwant-maps tile-data tile-server vector-tiles

Last synced: about 1 month ago
JSON representation

Central repository for Qwant Maps resources

Awesome Lists containing this project

README 

        


  QwantMaps






  Maps |

  Contribute |

  About |

  Frontend |

  Tile server |

  Geocoder |

  Internal API






🗺️ Qwant Maps is a map application that respects your privacy 🔍




![Qwant Maps screenshot](screenshot.png)



## Qwant Maps URLs



Qwant Maps provides links you can share with your friends to help them to #SwitchToQwant and #SwitchToOSM.

For instance, you can:

- search for a specific location on the map with the following format:  

`https://www.qwant.com/maps/#map=//`  

Example: https://www.qwant.com/maps/#map=12.08/48.8642287/2.3391427



- search a specific place on the map with the following path:  

`https://www.qwant.com/maps/place/`  

Example: https://www.qwant.com/maps/place/osm:node:532031656@LExpress_de_Lyon



#### A routing request



This endpoint points to a routing form and can pre-fill some of the fields.  

For instance: https://www.qwant.com/maps/routes/?origin=latlon:48.8459543:2.3714015&destination=latlon:48.8702200:2.27863300&mode[]=walking#map=18.00/48.8459543/2.3714015



The parameters corresponding to this endpoint are the following:



| Name | Required| Description |

| -------- | :--------: | -------- |

| origin    |   :x:   | `id` of some place to use as the starting point     |

| destination    |   :x:   | `id` of some place to use as the ending point  |

| mode   |   :x:   | if you want to pre-select a routing mode in the routing form. One of `walking`, `cycling`, `driving`, `public_transport`



## Architecture



Qwant Maps can be seen as 4 separated components:



* a tile server,

* a search engine (geocoder),

* an API to detail points of interest and places,

* a front end.



![global architecture](images/maps_archi.jpg)



NB: To provide the Qwant Maps service, Qwant hosts instances of the tile server, the geocoder and the Idunn API on its own servers.



Please note that Qwant instances are internal components and are not meant (yet) to be used directly other than as part of Qwant Maps. You can learn more in our [Terms of services](https://about.qwant.com/fr/legal/cgu/qwant-maps/)



#### Tile server



A tile server is a service whose job is to give all that is needed to display a fraction of a map.



Qwant Maps provides only [vector tiles](https://en.wikipedia.org/wiki/Vector_tiles) so the tile server does not serve images (as it is done with [raster tiles](https://switch2osm.org/the-basics/)) but raw data. It is the front end, [Erdapfel](#erdapfel), that takes the data and renders it into a user browsable map.



The tile server is a combination of 2 great opensource projects:



* [Planetiler](https://github.com/onthegomap/planetiler), a flexible tool to build planet-scale vector tilesets from OpenStreetMap data fast without database

* [OpenMapTiles](https://github.com/openmaptiles/openmaptiles), for their great and flexible tile schema.



OpenMapTiles makes it possible for Qwant Maps to have an [easy to define/extend](https://github.com/Qwant/openmaptiles) vector tile schema.



#### Geocoder



The geographical search engine (also called geocoder) used for Qwant Maps is [Bragi](https://github.com/CanalTP/mimirsbrunn).



Bragi is a geocoder based on [Elasticsearch](https://www.elastic.co) and rust components developed by [Kisio Digital](http://www.kisiodigital.com/).



#### Places API



To get more details on places and Points Of Interest (POIs), Qwant Maps uses an additional API: [Idunn](https://github.com/Qwant/idunn), that combines the information in the geocoder with external APIs to format detailed POIs data to display in the front end.



#### Front end 



Qwant Maps's front, [Erdapfel](https://github.com/Qwant/erdapfel), is a Javascript single page app that allows to browse the map, search for places, see your position on the map, etc.



The front end uses [Mapbox GL](https://www.mapbox.com/mapbox-gl-js/api/) to render the map, using both the tiles from the tile server, and Qwant Maps [custom map style](https://github.com/Qwant/qwant-basic-gl-style).



## Data



#### Tiles data 



The main source of data for the tile server is the awesome [OpenStreetMap](https://www.openstreetmap.org) (OSM) data :heart: but other data like [natural earth](http://www.naturalearthdata.com/), better water polygon... are also used.



To run the tileserver, we utilize a custom version of [Openmaptiles](https://github.com/openmaptiles/openmaptiles) adapt to work with [Planetiler](https://github.com/onthegomap/planetiler): we have a fork project of [Planetiler Openmaptiles](https://github.com/openmaptiles/planetiler-openmaptiles).



This configuration leverages the  [PMtiles format](https://github.com/protomaps/PMTiles), served by [Martin](https://github.com/maplibre/martin)



#### Geocoder data 



The data import process in [Mimirsbrunn](https://github.com/CanalTP/mimirsbrunn) is defined in a [python script](https://github.com/Qwant/docker_mimir/blob/master/tasks.py).



First, the OSM data is given to [Cosmogony](https://github.com/osm-without-borders/cosmogony) which outputs a big JSON file with all the world's administrative regions.



This file is then imported in Mimir by [cosmogony2mimir](https://github.com/CanalTP/mimirsbrunn#cosmogony2mimir).



We then import addresses using [addresses-importer](https://github.com/Qwant/addresses-importer). It downloads datasets of addresses (from [OpenAddresses](http://openaddresses.io/) and [OpenStreetMap](https://www.openstreetmap.org) mostly), deduplicate them and then import them into our geocoder using [openaddresses2mimir](https://github.com/CanalTP/mimirsbrunn#openaddresses2mimir).



The streets are imported afterwards, from the OSM pbf file with [osm2mimir](https://github.com/CanalTP/mimirsbrunn#osm2mimir).



Finally, the POIs are extracted from the PostgreSQL database created thanks to [imposm](https://github.com/omniscale/imposm3) using [Fafnir](https://github.com/Qwant/fafnir).



#### Places API data



Idunn does not need its own data import process, but the API depends on:



* the data of the [geocoder](#geocoder_data),

* Wikipedia data, fetched either on the Wikipedia APIs or in a custom Elasticsearch database.



##### OSM updates 



The world keeps moving and OpenStreetMap data is getting better and better every day, so we need to update the data in all our components on a regular basis.

We update the tiles entirely on weekly basis from [OSM planet pbf](https://registry.opendata.aws/osm/)



In the same time we have to up-to-date data in PostgreSQL, we can import again the geocoder POIs data with  the current version of the tiles.



We update the remaining geocoder data (administrative regions, streets and addresses) on a monthly basis.



## How to run



Qwant maps use to be fully Opensource but migrate to internal repository. Our idea is to keep update version on Github.