Digitransit UI - Reittiopas

Digitransit UI is a journey planner user interface built to work with OpenTripPlanner and the Digitransit platform.

Quick start

• yarn install
• yarn run dev, then open http://localhost:8080

See Installation for full requirements and options, and scripts/dev.sh API options for running against a DEV/PROD API subscription key.

Licensing

The source code of the platform is dual-licensed under the EUPL v1.2 and AGPLv3 licenses.

Issues

Our main issue tracking is handled in https://dev.azure.com/digitransit/digitransit However, we also monitor this repository's issues and import them to Azure Boards. You can create issues in GitHub.

Deployments

• HSL Reittiopas (Helsinki region) - https://reittiopas.hsl.fi
• National journey planner - https://matka.fintraffic.fi
• See digitransit.fi for more regional deployments

Testing

Digitransit-ui is tested to work on the latest and the second latest major versions of Firefox, Chromium and Safari.

• Continuous Integration: https://github.com/HSLdevcom/digitransit-ui/actions

Visual tests are run with jest and playwright.

More information about testing.

Workspace package scripts

Root-level commands covering all digitransit-* workspace packages at once (see Workspace Packages for detail):

• yarn workspace-packages-build — build every package
• yarn workspace-packages-test — run every package's tests
• yarn workspace-packages-watch — build, then rebuild on change
• yarn workspace-packages-clean — remove build output + node_modules
• yarn workspace-packages-docs — regenerate every package's README
• yarn workspace-packages-publish — publish changed packages to npm (interactive)
• yarn workspace-packages-publish-ci — same, non-interactive (used by CI)
• yarn workspace-packages-version-bump — bump versions locally (fetches tags first, doesn't push), should be run at the end of a PR that changes workspace packages right before it is merged
• yarn workspace-packages-version-check — verify versions/dependency ranges are consistent
• yarn workspace-packages-translations-check — verify digitransit-component packages' own translations are sorted and every locale has the same keys
• yarn workspace-packages-translations-fix — same, but sorts keys in place (key mismatches need a manual fix)

Documentation

• Architecture
• Terms, Positioning & Locations
• Run in Docker
• Installation
• Tests
• Z-Index Index
• Navigation
• Themes
• GeoJSON
• Workspace Packages