BikeHopper is a navigation app for everything but cars. It gives you directions that include riding a bike, taking transit, or both. We're developing and testing in the San Francisco Bay Area, California, but in principle it could be used anywhere in the world where transit info is available in GTFS format.
BikeHopper uses:
- OpenStreetMap street data
- Nominatim and Photon for geocoding
- A modified version of GraphHopper, for routing (Thank you to the original GraphHopper)
- A lightweight Node.js proxy we've written called bikehopper-web-app
- FormatJS and hosted Weblate for internationalization (WIP)
- For the Bay Area instance: transit data from 511.org
BikeHopper is free software under the GNU Affero General Public License, which requires the source to be kept open. We discourage corporate uses of BikeHopper, but highly encourage self-hosted, community instances in other regions. Get in touch if you'd like us to help you be the first region beyond the Bay Area to set one up.
This project uses Vite as its build system and
for running a dev server. To get started clone this repo,
copy the .env.development.template to .env.development.local and put in a
Mapbox token you create (free plan is fine), run npm install, then run npm start.
Requests to localhost are proxied to
https://api-staging.bikehopper.org. This is configured by a "proxy"
property within vite.config.json. Presently there is a thin client
library at src/lib/BikeHopperClient.ts. More methods should be added
as needed. This library calls the BikeHopper
backend.
To expose your dev server to your local network (so you can access it
from your phone), run npx vite --host.
If you're actively making changes to our fork of GraphHopper, follow these steps.
-
You'll need a local OSM cutout for Northern California.
wget http://download.geofabrik.de/north-america/us/california/norcal-latest.osm.pbf
Place the OSM cutout at
graphhopper/data/norcal-latest.osm.pbf. -
You'll also need GTFS data. Follow steps on this page, under "To Use the Feed and Ask Questions": https://www.interline.io/blog/mtc-regional-gtfs-feed-release/
Place the GTFS zip file at
graphhopper/data/GTFSTransitData_RG.zip. -
Edit the relevant variable in your
.env.development.localto point to local GraphHopper.
All user-facing strings should be wrapped in either <FormattedMessage>
instances or calls to intl.formatMessage, so that they can be translated. As
of August 2024 we translate to Spanish and most but not all of the app is
translated.
This is not yet automated, so currently, when you add a new string into the
code, or modify one, you should run npm run extract to extract the default
message and its description to the English-language file.
And after syncing translations from Weblate, run the script compile-langs.sh.
(The lack of symmetry is because this command was too complex to be put into
package.json.)