veggiekarte-local
Fork of veggiekarte for local use
GPL-3.0 License
Veggiekarte local
This is a fork of the world wide map veggiekarte from piratenpanda. This map is for local use. Improvements will be added to the upstream project.
Description
A OpenStreetMap based map to easily find places, like restaurants and cafes, with vegetarian and vegan options.
Usage
You can use it in any modern browser or install it as an app (as an PWA).
Get involved
There are several ways to get involved:
- Improve the data on OpenStreetMap
- Add missing places
- Add and correct information (like opening hours) of places
- Check and fix issues on https://veggiekarte.de/datacheck/
- Report issues
- Help to translate
- Translate to new languages - take locales/en.json as template.
- Complete translations: locales/ko.json is incomplete.
- Participate in development
- Write reviews for places on https://lib.reviews/
Keys
The most important keys for us are diet: vegan and diet: vegetarian. These keys are used to determine whether a place is shown on the Veggiekarte or not.
You can find an overview of which other keys we use at Taginfo.
Website
Third-party software and data
This is an overview of the third-party software and data we use. Many thanks to the open source community, especially to the authors of the following projects! ❤️ 🍻
| software | license | version | purpose |
|---|---|---|---|
| chart.js | MIT * | 4.4.0 | JavaScript library to creat charts. We use this in the data_chart.html. |
| i18next | MIT * | 23.7.3 | JavaScript internationalization framework. |
| leaflet | BSD-2-Clause * | 1.9.4 | JavaScript library to create interactive maps. |
| leaflet.control.geocoder | BSD-2-Clause * | 2.4.0 | A control to locate places. The button with the magnifier 🔍. |
| leaflet.easybutton | MIT * | 2.4.0 | Adding buttons. We are using it for the info button. |
| leaflet.featuregroup.subgroup | BSD-2-Clause * | 1.0.2 | Dynamically add/remove groups of markers. |
| leaflet.fullscreen | MIT * | 3.0.0 | Add a fullscreen button. |
| leaflet.hash | MIT * | 1.0.1 | Add coordinate hashes to the URL in the browser adress field. |
| leaflet.languageselector | CC0 * | 1.2.3 | A control to switch between languages. |
| leaflet.locatecontrol | MIT * | 0.79.0 | A control to locate the position of the user. |
| leaflet.markercluster | MIT * | 1.5.3 | Marker Clustering plugin. |
| opening_hours.js | LGPL-3.0-only * | 3.8.0 | Library to parse and process the opening_hours tag from OpenStreetMap data. |
| OpenStreeMap | CC BY-SA * | There we get the data of the places. We also show the markers on an OpenStreeMap map. | |
| icons from OpenStreetMap Carto | CC0 * | Default marker icons | |
| icons from Maki | CC0 | Fallback marker icons | |
| veggiepenguin | CC0 * | Favicon |
Scripts
Run python3 refresh.py to get new data from OpenStreetmap.
Run python3 datacheck/datacheck.py to run the data check on the data.
For developers
To produce a more consistent code we use node.js to prettify and lint the code. But node.js is not required to run Veggiekarte.
To use the tests you have to run npm install once to install the required packages. The prerequisite is that you have node.js installed on your system.
Then, to run the tests, run npm run test.