Skip to content

Commit

Permalink
Local update to try and install veggiekarte
Browse files Browse the repository at this point in the history
  • Loading branch information
@AIBappa
AIBappa committed Aug 31, 2024
1 parent b666597 commit 7bd4cf1
Show file tree
Hide file tree
Showing 1,815 changed files with 289,157 additions and 65,367 deletions.
22 changes: 0 additions & 22 deletions .eslintrc.json
View file

This file was deleted.

3 changes: 0 additions & 3 deletions .gitignore
View file

This file was deleted.

4 changes: 0 additions & 4 deletions .husky/pre-commit
View file

This file was deleted.

4 changes: 0 additions & 4 deletions .markdownlint.json
View file

This file was deleted.

4 changes: 0 additions & 4 deletions .prettierignore
View file

This file was deleted.

4 changes: 0 additions & 4 deletions .prettierrc.json
View file

This file was deleted.

8 changes: 0 additions & 8 deletions .stylelintrc.json
View file

This file was deleted.

94 changes: 30 additions & 64 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,73 +1,39 @@
# Veggiekarte local
# veggiekarte local

This is a fork of the world wide map [veggiekarte from piratenpanda](https://codeberg.org/piratenpanda/veggiekarte). This map is for local use. Improvements will be added to the upstream project.
This is a fork of the world wide map [veggiekarte from piratenpanda](https://github.com/piratenpanda/veggiekarte). This map is for local use. Improvements will be added to the upstream project.

## Description
## description

A OpenStreetMap based map to easily find places, like restaurants and cafes, with vegetarian and vegan options.
A map to find vegetarian/vegan POIs in your area.

## Usage
This project will hopefully evolve into a nice OpenStreetMap based map where you can find vegetarian and vegan restaurants and cafes easily.

You can use it in any modern browser or install it as an app (as an [PWA](https://en.wikipedia.org/wiki/Progressive_web_application)).
## website
* www.veggiekarte.de

## Get involved
## third-party

There are several ways to get involved:
This is an overview of the third-party software we use. Many thanks to the open source community, especially to the authors of the following software! ❤️ 🍻

1. Improve the data on OpenStreetMap
1. Add missing places
2. Add and correct information (like opening hours) of places
3. Check and fix issues on <https://veggiekarte.de/datacheck/>
2. Report issues
3. Help to translate
1. Translate to new languages - take [locales/en.json](locales/en.json) as template.
2. Complete translations: [locales/ko.json](locales/ko.json) is incomplete.
4. Participate in development
5. Write reviews for places on [https://lib.reviews/](lib.reviews)
|software |license |version |purpose |
|--- |--- |--- |--- |
|[fontawesome](https://github.com/FortAwesome/Font-Awesome/) | CC-BY-4.0, OFL-1.1, MIT [*](https://github.com/FortAwesome/Font-Awesome/blob/master/LICENSE.txt) | 5.14.0 | Webfont. We use it for the symbols for the control buttons. |
|[leaflet](https://github.com/Leaflet/Leaflet/) |BSD-2-Clause [*](https://github.com/Leaflet/Leaflet/blob/master/LICENSE) | 1.6.0 | JavaScript library to create interactive maps. |
|[leaflet.control.geocoder](https://github.com/perliedman/leaflet-control-geocoder/) |BSD-2-Clause [*](https://github.com/perliedman/leaflet-control-geocoder/blob/master/LICENSE) | 1.13.0 | A control to locate places. The button with the 🔍 on the top right. |
|[leaflet.easybutton](https://github.com/CliffCloud/Leaflet.EasyButton) |MIT [*](https://github.com/CliffCloud/Leaflet.EasyButton/blob/master/LICENSE) | 2.4.0| Adding buttons. We are using it for the info button. |
|[leaflet.featuregroup.subgroup](https://github.com/ghybs/Leaflet.FeatureGroup.SubGroup) |BSD-2-Clause [*](https://github.com/ghybs/Leaflet.FeatureGroup.SubGroup/blob/master/LICENSE) | 1.0.2| dynamically add/remove groups of markers |
|[leaflet.hash](https://github.com/siimots/leaflet-hash) |MIT [*](https://github.com/siimots/leaflet-hash/blob/master/LICENSE.md) | 1.0.1 | Add coordinate hashes to the URL in the browser adress field. |
|[leaflet.locatecontrol](https://github.com/domoritz/leaflet-locatecontrol/) |MIT [*](https://github.com/domoritz/leaflet-locatecontrol/blob/gh-pages/LICENSE) | 0.72 | A control to geolocate the user. The button with the marker on the top left. |
|[leaflet.markercluster](https://github.com/Leaflet/Leaflet.markercluster/) |MIT [*](https://github.com/Leaflet/Leaflet.markercluster/blob/master/MIT-LICENCE.txt) | 1.4.1 | Marker Clustering plugin. |
|icons from [OpenStreetMap Carto](https://github.com/gravitystorm/openstreetmap-carto) | CC0 | | default icons |
|icons from [Maki](https://labs.mapbox.com/maki-icons/) | CC0 | | fallback icons |
|[veggiepenguin](https://openclipart.org/detail/189178/veggiepenguin) | CC0 | | favicon |

## Keys

The most important keys for us are [diet: vegan](https://wiki.openstreetmap.org/wiki/DE:Key:diet:vegan) and [diet: vegetarian](https://wiki.openstreetmap.org/wiki/DE:Key: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](https://taginfo.openstreetmap.org/projects/veggiekarte#tags).

## Website

[www.veggiekarte.de](https://www.veggiekarte.de)

## 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](https://github.com/chartjs/Chart.js) | MIT [\*](https://github.com/chartjs/Chart.js/blob/master/LICENSE.md) | 4.4.0 | JavaScript library to creat charts. We use this in the `data_chart.html`. |
| [i18next](https://github.com/i18next/i18next) | MIT [\*](https://github.com/i18next/i18next/blob/master/LICENSE) | 23.7.3 | JavaScript internationalization framework. |
| [leaflet](https://github.com/Leaflet/Leaflet/) | BSD-2-Clause [\*](https://github.com/Leaflet/Leaflet/blob/master/LICENSE) | 1.9.4 | JavaScript library to create interactive maps. |
| [leaflet.control.geocoder](https://github.com/perliedman/leaflet-control-geocoder/) | BSD-2-Clause [\*](https://github.com/perliedman/leaflet-control-geocoder/blob/master/LICENSE) | 2.4.0 | A control to locate places. The button with the magnifier 🔍. |
| [leaflet.easybutton](https://github.com/CliffCloud/Leaflet.EasyButton) | MIT [\*](https://github.com/CliffCloud/Leaflet.EasyButton/blob/master/LICENSE) | 2.4.0 | Adding buttons. We are using it for the info button. |
| [leaflet.featuregroup.subgroup](https://github.com/ghybs/Leaflet.FeatureGroup.SubGroup) | BSD-2-Clause [\*](https://github.com/ghybs/Leaflet.FeatureGroup.SubGroup/blob/master/LICENSE) | 1.0.2 | Dynamically add/remove groups of markers. |
| [leaflet.fullscreen](https://github.com/brunob/leaflet.fullscreen) | MIT [\*](https://github.com/brunob/leaflet.fullscreen/blob/master/LICENSE) | 3.0.0 | Add a fullscreen button. |
| [leaflet.hash](https://github.com/siimots/leaflet-hash) | MIT [\*](https://github.com/siimots/leaflet-hash/blob/master/LICENSE.md) | 1.0.1 | Add coordinate hashes to the URL in the browser adress field. |
| [leaflet.languageselector](https://github.com/KristjanESPERANTO/Leaflet.LanguageSelector/) | CC0 [\*](https://github.com/KristjanESPERANTO/Leaflet.LanguageSelector/blob/master/LICENSE) | 1.2.3 | A control to switch between languages. |
| [leaflet.locatecontrol](https://github.com/domoritz/leaflet-locatecontrol/) | MIT [\*](https://github.com/domoritz/leaflet-locatecontrol/blob/gh-pages/LICENSE) | 0.79.0 | A control to locate the position of the user. |
| [leaflet.markercluster](https://github.com/Leaflet/Leaflet.markercluster/) | MIT [\*](https://github.com/Leaflet/Leaflet.markercluster/blob/master/MIT-LICENCE.txt) | 1.5.3 | Marker Clustering plugin. |
| [opening_hours.js](https://github.com/opening-hours/opening_hours.js) | LGPL-3.0-only [\*](https://github.com/opening-hours/opening_hours.js/blob/master/LICENSES/LGPL-3.0-or-later.txt) | 3.8.0 | Library to parse and process the opening_hours tag from OpenStreetMap data. |
| [OpenStreeMap](https://www.openstreetmap.org) | CC BY-SA [\*](https://www.openstreetmap.org/copyright) | | There we get the data of the places. We also show the markers on an OpenStreeMap map. |
| icons from [OpenStreetMap Carto](https://github.com/gravitystorm/openstreetmap-carto) | CC0 [\*](https://github.com/gravitystorm/openstreetmap-carto/blob/master/LICENSE.txt) | | Default marker icons |
| icons from [Maki](https://labs.mapbox.com/maki-icons/) | CC0 | | Fallback marker icons |
| [veggiepenguin](https://openclipart.org/detail/189178/veggiepenguin) | CC0 [\*](https://openclipart.org/share) | | 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`.
## Installation in local folder in your own laptop or desktop running Windows 10.
1) Clone this Github folder
2) Open using VSCode Insiders
3) Install Live Server extension
4) Right click on index.html and run in live server.
5) The browser runs on localhost and shows an OSM map with the data from the "data folder" for places.json.
6) The python scripts *.py are to retrieve the data from OSM via overpass and keep it locally in the places.json file.
7) Python script needs urllib3 which can be acquired via virtual environment in python or dockerfile. Dockerfile not provided here, work it out!!
1 change: 1 addition & 0 deletions _config.yml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
theme: jekyll-theme-cayman
21 changes: 0 additions & 21 deletions css/datacheck.css
View file

This file was deleted.

Loading

0 comments on commit 7bd4cf1

Please sign in to comment.