forked from graphhopper/graphhopper
-
Notifications
You must be signed in to change notification settings - Fork 1
/
params.json
6 lines (6 loc) · 7.1 KB
/
params.json
1
2
3
4
5
6
{
"name": "Biketourplanner",
"tagline": "A nwjs application for offline planning of bicycle tours. BikeTourPlanner is OpenSource.",
"body": "# BikeTourPlanner\r\n\r\nBikeTourPlanner is an open source [nw](http://nwjs.io/) desktop application for offline planning of bicycle tours based on the [GraphHopper](https://github.com/graphhopper/graphhopper) routing engine. \r\nIt allows the user to generate the routing data from [OpenStreetMap](http://www.openstreetmap.org/about) (OSM) data.\r\nIt uses offline maps which are provided by [OSM2VectorTiles](http://osm2vectortiles.org/about) and displayed using [Leaflet](https://github.com/mapbox/mapbox-gl-js) and [mapbox-gl-js](https://github.com/mapbox/mapbox-gl-js). \r\nBikeTourPlanner comes with an integrated local vector tile map server which uses [nodejs](https://nodejs.org/en/). \r\nBikeTourPlanner requires an installed Java 8 runtime.\r\n\r\nThe currently supported platforms are: \r\n\r\n* Linux 64-bit \r\n* Microsoft Windows 64-bit. \r\n\r\nImplementation of support for Mac OS X 64-bit should be possible with few changes.\r\n\r\nThe look and feel is similar to [GraphHopper Maps](https://graphhopper.com/maps) as most parts are identical. Here is a screen-shot of the main window:\r\n\r\n![BikeTourPlanner](biketourplanner/doc/BikeTourPlanner_001.png)\r\n\r\nBikeTourPlanner comes with the map and OSM data of Liechtenstein. \r\nThe map features and the routing features are completely separated. \r\nThis means changing a region requires the user to switch the map in one step and in a second step to seperatly switch the covered routing area. \r\nThe reason is that the data comes from two separated sources.\r\n\r\n## Map features\r\n* Integrated download possibility for the installation of OSM2VectorTiles map extracts. \r\n* Rendering of OSM bicycle route relations in four different colors, which are derived from the OSM `network` tag. Unpaved way segments show up as a dotted line\r\n* Bicycle specific point of interests:\r\n * Logging with the possibility to show up OSM features\r\n * Campsites with the possibility to show up OSM features\r\n * Bicycle shops with the possibility to show up OSM features\r\n * Alpine huts with the possibility to show up OSM features\r\n * Hospitals with the possibility to show up OSM features\r\n * Drinking water\r\n * Supermarkets\r\n * Restaurants\r\n * Fast food\r\n * Fuel\r\n* BikeTourPlanner comes with the bicycle specific rendering covering the Liechtenstein area to keep the package small.\r\n It is possible to replace the contained two files with two files hosted on ??? in order to extend the bicycle specific \r\n rendering to world wide coverage. This download would be about 1.4GB\r\n* Display of smoothed elevation profile\r\n* The usage of a map containing the whole planet is possible. Its size currently (2016) is about 56GB. Please do not try to download the whole planet via the menu, but rather use a web browser for downloading it.\r\n\r\n## Routing features\r\n* Routing profiles are switchable between bicycle types commuting, mountainbike and racebike\r\n* OSM file download from [GeoFabric](http://download.geofabrik.de) can be started from the menu\r\n* Routing data is locally stored. Switching between the covered routing regions is possible via the menu\r\n* Calculation of routing data from *.pbf or *.osm OSM files. The duration for a calculation depends on the size of the OSM file and the covered area. Please note that calculation of the routing data is time consuming. \r\n* The region size which can be handled mainly depends on the RAM. 8 GB RAM should currently (2016) be sufficient to cover the whole DACH area (Germany, Switzerland, Austria). For a German Bundesland 4 GB RAM should be sufficient.\r\n* Automatic download of elevation data during route data calculation. This data is cached locally. This process requires internet connectivity in case that the cache does not contain the region. This data might become pretty big.\r\n* Route from A to B with optional stopover points\r\n* Round-trips from a starting point with a targeted distance and optional heading\r\n* Display of the distance spent on way classifications\r\n* Display of guessed ascend. Please note that the calculated value might be quite inaccurate!\r\n* Tuning between fast or nice routes\r\n* Routing takes elevation data into account. Tuning between steep or flat routes is possible for all the bicycle types\r\n* Alternative routes calculation\r\n* GPX export\r\n* Storing of tours and modification of stored tours\r\n\r\n##Other features\r\n* The OSM files, the vector tiles, and calculated graph data reside under the data folder located relative to the intallation root folder.\r\n* Searching OSM data by name and address via [Nominatim](http://wiki.openstreetmap.org/wiki/Nominatim) is possible but requires internet connectivity.\r\n* As the application uses a local web server, its URL located at http://localhost:8989 may be accessed via web browsers on the same machine. \r\n In case that firewall rules allows it, this server can be accessed from other hosts with the network, but routing would require a manual change \r\n of the `localhost` string in the file js\\config\\options.js into the local IP address.\r\n The application menu serves as management interface for the server.\r\n\r\n## Limitations\r\n* Altough localisation code would be available in those parts which are common to GraphHopper, the localiszation is hard-coded to English. This way mixing up of languages is avoided.\r\n\r\n## Bugs\r\nReport bugs on [https://github.com/ratrun/biketourplanner](https://github.com/ratrun/biketourplanner/issues)\r\n \r\n## Developer information\r\nThe BikeTourPlanner [nw](http://docs.nwjs.io/en/latest/) application root is located under [web\\src\\main\\webapp\\package.json](web\\src\\main\\webapp\\package.json).\r\nThe GraphHopper graphhopper-web-x.y-SNAPSHOT-with-dep.jar file checked in under [web\\src\\main\\webapp\\graphhopper](web\\src\\main\\webapp\\graphhopper) is the result of the Graphhopper Web NetBeans project. This file may be built built from the contained modified GraphHopper source file and checked in to git under web\\src\\main\\webapp\\graphhopper (web\\src\\main\\webapp\\graphhopper\\graphhopper-web-x.y-SNAPSHOT-with-dep.jar). The documentation for the graphopper build process is located under [docs\\core\\quickstart-from-source.md](docs\\core\\quickstart-from-source.md).\r\nThe vector tile server is located at [web\\src\\main\\webapp\\ratrun-mbtiles-server](web\\src\\main\\webapp\\ratrun-mbtiles-server) is a git submodul.\r\nDevelopment requires installed [nodejs](https://nodejs.org/en/). Installation is performed with `npm install -g nw --nwjs_build_type=sdk`\r\n\r\nAfter git clone, the command `npm install` needs to be executed in the following folders:\r\n\r\n* [web](web)\r\n* [web\\src\\main\\webapp](web\\src\\main\\webapp)\r\n* [web\\src\\main\\webapp\\ratrun-mbtiles-server](web\\src\\main\\webapp\\ratrun-mbtiles-server)\r\n \r\nThe application is started by running [`nw`](http://nwjs.io/) from [web\\src\\main\\webapp](web\\src\\main\\webapp)\r\n\r\n",
"note": "Don't delete this file! It's used internally to help with page regeneration."
}