Classic openrouteservice maps client

The classic openrouteservice(ors) maps client is an online route planning application that is based on open source software, open data and open standards.

It uses the openrouteservice API and needs a valid API key (free up to a certain request limit per day)

Installation

Requirements:

• git
• docker
• docker-compose

Clone the repository

git clone https://github.com/GIScience/openrouteservice-app.git

# switch to repository folder
cd openrouteservice-app

First Replace weathercheck.txt content with your Api-Key:

# Open `app/weathercheck.txt` in your favorite text editor and replace the content with your Token.
# e.g.:
vim app/weathercheck.txt

Build the docker image:

docker-compose build

Running the client

Run docker-compose up:

docker-compose up -d

The app will be exposed on http://localhost:8035

Running in development mode

• open on http://localhost:3005
• container will be removed after stopping

Normal endpoints:

docker-compose run -p 3005:3005 --rm ors-classic-maps dev

If you want to use the openrouteservice client with a local backend version of openrouteservice you have to adjust the endpoint paths to the backend war version you are using in Grunfile.js.

Local ors backend:

docker-compose run -p 3005:3005 --rm ors-classic-maps ors_local

Install dependencies locally

If you want to have all dependencies locally, installation is a bit more difficult. Also, the commands for running the client are a bit different.

Requirements:

• git
• nodejs
• Api-key

Permission Issues

If you encounter any permission issues during the installation:

• on Linux: try running npm-commands with sudo :

e.g.:

sudo npm install

• on Windows(GitBash recommended): try running npm-commands with the --no-optional flag:

e.g.:

npm install --no-optional

Installation

After cloning the repository:

• Install dependencies:

# install all modules listed as dependencies in package.json
npm install

# install dependencies listed in bower.json
node_modules/bower/bin/bower install

• Initiate default files:

# Copy `Gruntfile.default.js` to `Gruntfile.js`
cp Gruntfile.default.js Gruntfile.js

# Copy `weathercheck.default.txt` to `weathercheck.txt`
cp app/weathercheck.default.txt app/weathercheck.txt

Don't forget to edit weathercheck.txt and insert your API key.

Run openrouteservice:

To enable console output information and logging for bug-fixing and feature development do:

grunt dev

To build for production (all output in build folder):

grunt ors

To use a local ors backend:

grunt ors_local

Contribution

If you would like to contribute, please note that we are using a branching model to structure our git workflow and are following commit message guidelines.

For minor bugfixes use the development branch:

git checkout development

For new features, please create a new branch:

git checkout -b feature_branch

Do a pull request to our development branch. Be sure to pull the latest changes beforehand and fix any emerging conflicts.

Translations

Help us to provide the openrouteservice in your language by translating some simple keywords!

In this spreadsheet you can add a column for your language or check the already added words if they are correctly translated. Our service will be updated regularly with the latest language versions.

If there are further questions, please let us know!

License

(The MIT License)

Copyright (c) 2017 GIScience Research Group, Heidelberg University.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.