Skip to content

Latest commit

 

History

History
90 lines (57 loc) · 5.04 KB

index.md

File metadata and controls

90 lines (57 loc) · 5.04 KB

GraphHopper Documentation

First Steps

Try out our live demo called GraphHopper Maps

GraphHopper Maps

The Readme lists all features.

See users of GraphHopper and let us know your application!

Community

For all questions regarding the GraphHopper routing engine please use our forum. For bugs see our contributing guide.


Installation

Install the GraphHopper routing engine with the GraphHopper Maps UI with this installation guide on your machine. This will also install a web API that can be used in many programming languages.

  • Routing API: Documentation of the Web API to communicate with any GraphHopper server via http.
  • Deployment Guide: Details about deploying GraphHopper
  • There are official API clients in Java and JavaScript.

Configuration

You can configure several aspects either programmatically or just via a configuration. The configuration of routing profiles is documented here. The elevation configuration is separately documented here.


Installation For Developers

The quickstart is an introduction for developers. Explains git checkout, IDE setup and commands for setting up a GraphHopper server.

Find all changes in previous and current versions in the changelogs.

Contribute

Read here on how to contribute as a developer and translator.

Technical

Various topics are explained in more detail separately:

Other links

Android & iOS

The Android demo, that shows how to use GraphHopper for offline routing on Android, was available until GraphHopper 1.0.

There is a GraphHopper fork for iOS that allows to do offline routing on iOS. See the Instructions on how to setup this here including a sample application. See the necessary changes for modern iOS and GraphHopper 1.0 in this pull request.

Windows

Install the Windows Subsystem for Linux (WSL) or cygwin and follow the normal installation steps.

When using Powershell or cmd the easiest way is to download all files manually (see the wget parameters) and then run the java command but replace the wildcard (-jar graphhopper*.jar) with the exact jar file.

Eclipse

Setup in IntelliJ and NetBeans is just via open project. See this document to set up GraphHopper in Eclipse with maven.