brouter-web

Web client (by @nrenner) for the BRouter routing engine (by @abrensch). Work in progress.

New web client available mobile-ready to test on brouter.damsy.net. Feedbacks are appreciated, do not hesitate to create issues about it!

BRouter online service (provided by @abrensch):
http://brouter.de/brouter-web/

This repository is only about the frontend. For the server/backend, BRouter routing engine, Android app, profiles, brouter.de site, see:
https://github.com/abrensch/brouter

More information:
http://brouter.de

General BRouter discussions/questions, support:
https://groups.google.com/group/osm-android-bikerouting

Installation

As an alternative to the above online version, the standalone server of BRouter can also be run on your local desktop.

Install BRouter (server with routing engine)

1. download and unzip latest BRouter revision
   e.g. for Linux (replace ~/opt/ with your preferred install dir and 1_4_1 with latest version):

    mkdir ~/opt/brouter
    cd ~/opt/brouter
    wget http://brouter.de/brouter_bin/brouter_1_4_1.zip
    unzip brouter_1_4_1.zip
    chmod +x ./standalone/server.sh
   

2. download one or more data file(s) (rd5) into segments4 dir

Install BRouter-Web (client)

1. download BRouter-Web as subdirectory brouter-web of the brouter directory

   • using the latest stable release - adjust to current version number - from https://github.com/nrenner/brouter-web/releases:

     wget https://github.com/nrenner/brouter-web/archive/0.6.3.zip
     unzip 0.6.3.zip
     mv brouter-web-0.6.3 brouter-web
     

   • OR the current development state (potentially instable and without runtime distributables):

     wget https://github.com/nrenner/brouter-web/archive/master.zip
     unzip master.zip
     mv brouter-web-master brouter-web
     

     • build the distributable files required for runtime (only for development state), see section Build

2. copy config.template.js to config.js

3. configure URL to profiles2 directory
   set BR.conf.profilesUrl in config.js, e.g. uncomment:

    BR.conf.profilesUrl = 'http://localhost:8000/profiles2/';
   

4. add your API keys (optional)
   copy keys.template.js to keys.js and edit to add your keys

Run

1. start BRouter server in the standalone directory with ./server.sh or server.cmd (Windows)

2. serve the brouter directory for BRouter-Web
   This is needed for pre-loading the selected profile (unless you allowed local file access in the Browser). Depending on your setup (see How to run things locally), start a web server in the brouter directory, e.g.:

    python -m SimpleHTTPServer
   

3. open http://localhost:8000/brouter-web/

Build

Dependencies

Requires Node and npm (or io.js), Bower and Gulp:

npm install -g bower
npm install -g gulp

Install

npm install
bower install

Build

gulp #for release
gulp debug #for development

Develop

gulp watch

License

Copyright (c) 2016 Norbert Renner and contributors, licensed under the MIT License (MIT)

Credits and Licenses

• BRouter (not included)
  by abrensch; GNU General Public License, version 3.0 (GPLv3)
• Leaflet
  Copyright (c) 2010-2014, Vladimir Agafonkin; Copyright (c) 2010-2011, CloudMade; 2-clause BSD License
• leaflet-routing
  Copyright (c) 2013, Turistforeningen, Hans Kristian Flaatten. All rights reserved. 2-clause BSD License
• Leaflet.Elevation
  Copyright (c) 2013 Felix Bache; MIT License
• D3.js
  Copyright (c) 2013, Michael Bostock. All rights reserved.; 3-clause BSD License
• Leaflet.Editable
  Yohan Boniface; WTFPL licence
• Leaflet Control Geocoder
  Copyright (c) 2012 sa3m, Copyright (c) 2013 Per Liedman; 2-clause BSD License
• leaflet-plugins
  Copyright (c) 2011-2012, Pavel Shramov; 2-clause BSD License
• Async.js
  Copyright (c) 2010-2014 Caolan McMahon; MIT License
• Bootstrap
  Copyright (c) 2011-2014 Twitter, Inc; MIT License
• jQuery
  Copyright 2005, 2014 jQuery Foundation and other contributors; MIT License
• DataTables
  Copyright (C) 2008-2014, SpryMedia Ltd.; MIT License
• Leaflet.EasyButton
  Copyright (C) 2014 Daniel Montague; MIT License
• Bootbox
  Copyright (C) 2011-2014 by Nick Payne; MIT License
• bootstrap-slider
  Copyright (c) 2015 Kyle Kemp, Rohit Kalkur, and contributors; MIT License
• Leaflet.RestoreView
  Copyright (c) 2012 Makina Corpus, MIT License
• Leaflet.Locate
  Copyright (c) 2014 Dominik Moritz, MIT License
• Font Awesome
  by Dave Gandy; SIL OFL 1.1 (Font), MIT License (Code), CC BY 3.0 (Documentation)