Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
abhumbla authored Jan 2, 2025
1 parent 8c41453 commit 1ab854d
Showing 1 changed file with 3 additions and 34 deletions.
37 changes: 3 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,29 +6,14 @@ 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](https://openstreetmap.org/) street data
- [Nominatim](https://nominatim.org/) and
[Photon](https://github.com/komoot/photon) for geocoding
- A [modified version of
GraphHopper](https://github.com/bikehopper/graphhopper), for routing
(Thank you to the original
[GraphHopper](https://www.graphhopper.com/))
- A lightweight Node.js proxy we've written called
[bikehopper-web-app](https://github.com/bikehopper/bikehopper-web-app)
- [FormatJS](https://formatjs.io/) and [hosted
Weblate](https://hosted.weblate.org/projects/bikehopper/bikehopper-ui/) for
internationalization (WIP)
- _For the Bay Area instance:_ transit data from
[511.org](https://511.org/open-data/transit)

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 is the frontend! Here's how to get started. For setting up the whole project, see the [project README](https://github.com/bikehopper/)

## Getting Started With the BikeHopper UI

This project uses [Vite](https://vitejs.dev/) as its build system and
Expand All @@ -46,23 +31,7 @@ as needed. This library calls the BikeHopper
To expose your dev server to your local network (so you can access it
from your phone), run `npx vite --host`.

## Configuring local GraphHopper

If you're actively making changes to [our fork of GraphHopper](https://github.com/bikehopper/graphhopper), follow these steps.

1. You'll need a local OSM cutout for Northern California.

```sh
wget http://download.geofabrik.de/north-america/us/california/norcal-latest.osm.pbf
```

Place the OSM cutout at `graphhopper/data/norcal-latest.osm.pbf`.

2. 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`.

3. Edit the relevant variable in your `.env.development.local` to point to local GraphHopper.
If you are running [local graphhopper](https://github.com/graphhopper/graphhopper), Edit the relevant variable in your `.env.development.local` in `bikehopper-ui` to point to local GraphHopper.

## Internationalization

Expand Down

0 comments on commit 1ab854d

Please sign in to comment.