Skip to content

Latest commit

 

History

History
40 lines (26 loc) · 1.91 KB

README.md

File metadata and controls

40 lines (26 loc) · 1.91 KB
Raw

otp-react-redux

A library for writing modern OpenTripPlanner-compatible multimodal journey planning applications using React and Redux.

Running the Example

An example of an OTP-RR application is included in the repository. The example project is a single page application with a root entry point of the example.js file. This example.js file can be modified to suit the needs of a particular implementation.

To run, first clone the repo and install yarn if needed.

Copy example-config.yml to config.yml. Update config.yml with the needed API keys, and optionally, the OTP endpoint and initial map origin. (The default values are for a test server for Portland, OR.).

Install the dependencies and start a local instance using the following script:

yarn start

Deploying the UI

  1. Build the js/css bundle by running yarn build. The build will appear in the dist/ directory).
  2. Modify the index.html to point to dist/index.js (instead of example.js).
  3. Upload the following files to wherever you're deploying the UI:
  • index.html (modified to point to dist/index.js)
  • example.css
  • dist/
    • index.js
    • index.js.map
    • index.css
    • index.css.map

Note: only contents produced during build in the dist/ directory are likely to change over time (the index.html and example.css files contain minimal code), so subsequent deployments will typically only need to replace the dist/ contents.

Library Documentation

More coming soon...

As of version 2.0, otp-react-redux utilizes React's context API in a number of components. This changed the way that some components receive props such that they will not work properly unless wrapped with the context provider used in the ResponsiveWebapp component.