Repository: QwantResearch/qwantmaps
Branch: master
Commit: f0017fd19005
Files: 8
Total size: 24.3 KB
Directory structure:
gitextract_ezspbama/
├── .github/
│ └── ISSUE_TEMPLATE/
│ ├── bug_report.md
│ ├── feature_request.md
│ └── question.md
├── CHANGELOG.md
├── LICENSE
├── contributing.md
├── images/
│ └── readme.md
└── readme.md
================================================
FILE CONTENTS
================================================
================================================
FILE: .github/ISSUE_TEMPLATE/bug_report.md
================================================
---
name: Bug report
about: Report a bug you encountered in Qwant Maps
title: ''
labels: bug
assignees: ''
---
================================================
FILE: .github/ISSUE_TEMPLATE/feature_request.md
================================================
---
name: Feature request
about: Suggest an idea for the project
title: ''
labels: enhancement
assignees: ''
---
================================================
FILE: .github/ISSUE_TEMPLATE/question.md
================================================
---
name: Question
about: You have a question or a topic you want to discuss about the project
title: ''
labels: question
assignees: ''
---
================================================
FILE: CHANGELOG.md
================================================
# Qwant Maps Changelog
## Release v0.1.2
Release date: May 22, 2019
### Components
* Erdapfel [v0.1.9](https://github.com/QwantResearch/erdapfel/releases/tag/v0.1.9)
* Idunn [v0.1.5](https://github.com/QwantResearch/idunn/releases/tag/v0.1.5)
* Mimir [v1.7.0](https://github.com/CanalTP/mimirsbrunn/releases/tag/v1.7.0)
### Improvements
- Add "images" to the POI panel
- Add possibility to fetch multiple external data sources
- Fix in wiki details request
- Optimization in "opening hours" parsing
- Fix directions
- IE11 better compatibility
- Suggest improvements
- Masq integration
- Category filters
- Add image thumbnail on POI
- Misc minor fixes
## Release v0.1.1
Release date: April 1, 2019
### Components
* Erdapfel [v0.1.8](https://github.com/QwantResearch/erdapfel/tree/v0.1.8)
* Idunn [v0.1.4](https://github.com/QwantResearch/idunn/releases/tag/v0.1.4)
* Mimir [v1.7.0](https://github.com/CanalTP/mimirsbrunn/releases/tag/v1.7.0)
### Improvements
* Itineraries available for cars, pedestrians and bicycles.
* Internationalized queries possible for administrative zones (cities, regions...).
* Improvements on search field and geolocation process
* Improvements about Directions UI and error handling
* Misc fixes
================================================
FILE: LICENSE
================================================
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
================================================
FILE: contributing.md
================================================
# Contributing
Want help us on Qwant Maps ? Awesome, thanks for taking the time to contribute ! Here are a few things you can do.
# Improving the map
Qwant Maps main data source is OpenStreetMap (OSM). It's an international project to create an open geographical database of the entire world: https://www.openstreetmap.org/about
If you know your neighborhood, you are entitled to participate: join the community and improve the map with us.
You will need a free account here: https://www.openstreetmap.org/user/new
To get you started, check out:
* https://www.openstreetmap.org/welcome
* https://learnosm.org/fr/beginner/
* https://wiki.openstreetmap.org/wiki/Contribute_map_data
* [French local chapter website](https://www.openstreetmap.fr/contribuer/) (:fr:)
# Translating
:fr: :it: :ru: :de: *Help us bring Qwant Maps in your language* :jp: :kr: :cn: :es:
You can join the translation team on [transifex](https://www.transifex.com/qwant-1/qwant-maps/), ask for your language and start translating.
# Reporting Bugs or suggesting enhancements
If you find a bug on the map (a missing place or some outdated location), you can fix it by [contributing to OpenStreetMap](https://www.openstreetmap.org/welcome). If you don't want to take the time to sign up and learn how to edit, you can also [add a note on OSM website](https://www.openstreetmap.org/note/new) so other contributors may investigate.
Otherwise, you can [submit an issue](https://github.com/Qwant/qwantmaps/issues/new) in this repository. Please provide as much details as you can, with screenshots and steps to reproduce.
# Contributing code and documentation changes
If you want to deep dive and help out with some development on Qwant Maps, then first read along in this repository to understand the architecture and find out some repository to contribute on. [Cosmogony](https://github.com/osm-without-borders/cosmogony) (the tool we use to understand administrative zones) or [Erdapfel](https://github.com/Qwant/erdapfel) (Qwant Maps website) may be good candidates to get started.
If you have a bugfix or new feature that you would like to contribute to the project, please find or open an issue about it first: maybe we are already working on it, or there are particular issues that you should know about before implementing the change. :pray: Thanks again!
# Expanding
:earth_americas: *Help us bring Qwant Maps in your country* :earth_asia:
Qwant Maps is developed in France and for now has been mainly tested by French people. We need your local knowledge to make it work in the entire world :rocket:
* Test Qwant Maps in your language and in your country and tell us what should be improved
* [Join](https://wiki.openstreetmap.org/wiki/Mailing_lists) your local OpenStreetMap community, meet other mappers and improve the map
* Tell us more about the administrative divisions in your country: we need them to add local context to your geographical searches. Learn more with [Cosmogony](https://github.com/osm-without-borders/cosmogony#contribute)
* Enrich the test cases we use for our geographical search engine by contributing to [geocoder-tester](https://github.com/qwant/geocoder-tester): Write a few search queries for your country and tell us what you expect Qwant Maps to find when you type these queries. [This file](https://github.com/qwant/geocoder-tester/blob/master/geocoder_tester/world/italy/test_from_user_input.csv) provides a good example :it: to get you started.
* Did we mention "contribute to OpenStreetMap" ? :wink:
# Update
When should you expect your contributions on Qwant Maps ?
* Point of interest are updated on a daily basis.
* Addresses are updated on a monthly basis.
# Others
There are many other ways to contribute, from improving the documentation to writing blog posts. Please share your favorite locations on Qwant Maps with your friends and help them #SwitchToQwant #SwitchToOSM
================================================
FILE: images/readme.md
================================================
# Note
The images were generated with [draw.io](https://www.draw.io/).
when editing an image don't forget to update both the raw data (.xml) and the generated image.
================================================
FILE: readme.md
================================================
🗺️ Qwant Maps is a map application that respects your privacy 🔍
## 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.
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.