https://github.com/Project-OSRM/osrm-frontend

Modular rewrite of the OSRM frontend using LRM
https://github.com/Project-OSRM/osrm-frontend

frontend osrm routing

Last synced: 27 days ago
JSON representation

Modular rewrite of the OSRM frontend using LRM

• Host: GitHub
• URL: https://github.com/Project-OSRM/osrm-frontend
• Owner: Project-OSRM
• License: bsd-2-clause
• Created: 2014-09-15T14:57:50.000Z (over 10 years ago)
• Default Branch: gh-pages
• Last Pushed: 2024-04-12T05:18:56.000Z (8 months ago)
• Last Synced: 2024-04-14T21:53:42.996Z (8 months ago)
• Topics: frontend, osrm, routing
• Language: JavaScript
• Homepage:
• Size: 24.2 MB
• Stars: 300
• Watchers: 29
• Forks: 231
• Open Issues: 106
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# osrm-frontend

This is the frontend served at https://map.project-osrm.org.

This frontend builds heavily on top of [Leaflet Routing Machine](https://github.com/perliedman/leaflet-routing-machine).

If you need a simple OSRM integration in your webpage, you should start from there.

## Using Docker

The easiest and quickest way to setup your own routing engine backend is to use Docker images we provide.

We base [our Docker images](https://hub.docker.com/r/osrm/osrm-frontend/) on Alpine Linux and make sure they are as lightweight as possible.

Serves the frontend at `http://localhost:9966` running queries against the routing engine backend:

```

docker run -p 9966:9966 osrm/osrm-frontend

```

Per default routing requests are made against the backend at `http://localhost:5000`.

You can change the backend by using `-e OSRM_BACKEND='http://localhost:5001'` in the `docker run` command.

In case Docker complains about not being able to connect to the Docker daemon make sure you are in the `docker` group.

```

sudo usermod -aG docker $USER

```

To build the docker image locally:

```bash

docker build . -f docker/Dockerfile -t osrm-frontend

docker run -p 9966:9966 osrm-frontend

```

## Development

Install dependencies via

```bash

npm install

```

Then compile assets and start the local server with

```bash

npm start

```

On Windows with no Unix tools installed (`bash`, `sed`, `cp`) the server could be started with two other commands

executed by `npm start` internally:

```bash

npm run compile

npm run start-index

```

## Changing Backends

In `src/leaflet_options.js` adjust:

```

services: [{

  label: 'Car (fastest)',

  path: 'http://localhost:5000/route/v1'

}],

```

For debug tiles showing speeds and small components available at `/debug` adjust in `debug/index.html`

```

"osrm": {

  "type": "vector",

  "tiles" : ["http://localhost:5000/tile/v1/car/tile({x},{y},{z}).mvt"]

}

```