Skip to content

hannes-k/mapbox-directions.js

 
 

Repository files navigation

mapbox-directions.js

Build Status

This is a Mapbox.js plugin for the Mapbox Directions API. Its main features include:

  • Input controls for origin and destination
  • Draggable origin and destination markers
  • Draggable intermediate waypoints
  • Display of turn-by-turn instructions
  • Selection of alternate routes

Managed as Markdown in API.md, following the standards in DOCUMENTING.md

Development

Run npm install to install dependencies.

The npm start task will start up a live-reloading and regenerating development server.

Building

Requires node.js installed on your system.

git clone https://github.com/mapbox/mapbox-directions.js.git
cd mapbox-directions.js
npm install
make

This project uses browserify to combine dependencies and installs a local copy when you run npm install. make will build the project in dist/.

Tests

Test with smokestack:

npm test

Packages

No packages published

Languages

  • JavaScript 85.5%
  • HTML 13.8%
  • Makefile 0.7%