Skip to content
This repository has been archived by the owner on Feb 24, 2023. It is now read-only.

Latest commit

 

History

History
22 lines (11 loc) · 1.4 KB

README.md

File metadata and controls

22 lines (11 loc) · 1.4 KB
Raw

otp.js

A lightweight library for modular development of modern OpenTripPlanner front-end interfaces.

The core of the library is a collection of data models and views (lib/), written using backbone.js, that encapsulate OTP API requests and responses (OTP API version 0.10+). Also included is a simple web client (client/) that shows how otp.js can be used to create a functional OTP front-end.

otp.js uses Component for dependency and build process management.

Getting Started

To get started with otp.js and the sample web client:

  1. Clone the otp.js repo to your local machine using git clone https://github.com/conveyal/otp.js.git

  2. Install npm if needed. In the otp.js project directory, run npm install to install Component and set up the development environment (this in configured in package.json).

  3. Run make, which invokes Component to download any required dependencies and package them together with the local otp.js code (a copy of the packaged code is put in client/build/). Make also copies client/ to client_no_symlinks/, replacing all symlinks with a copy of the files they point to.

  4. Update the default configuration in client_no_symlinks/config.js to point to your OTP backend.

  5. Deploy the client to the web by copying the client_no_symlinks/ directory to your web server.