Web client for BRouter
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
css
js
.gitignore
CHANGELOG.md
LICENSE
README.md
bower.json
config.template.js
gulpfile.js
index.html
keys.template.js
package.json

README.md

brouter-web

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

Instances:

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_11 with latest version):

     mkdir ~/opt/brouter
     cd ~/opt/brouter
     wget http://brouter.de/brouter_bin/brouter_1_4_11.zip
     unzip brouter_1_4_11.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/releases/download/0.7.0/brouter-web-0.7.0.zip
      unzip brouter-web-0.7.0.zip -d 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) 2018 Norbert Renner and contributors, licensed under the MIT License (MIT)

Credits and Licenses