Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/derhuerst/nahsh-gtfs-rt-server
Expose Schleswig-Holstein & Hamburg transit data as a GTFS-RT feed.
https://github.com/derhuerst/nahsh-gtfs-rt-server
Last synced: 6 days ago
JSON representation
Expose Schleswig-Holstein & Hamburg transit data as a GTFS-RT feed.
- Host: GitHub
- URL: https://github.com/derhuerst/nahsh-gtfs-rt-server
- Owner: derhuerst
- License: other
- Created: 2021-10-23T12:46:40.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-01-18T14:20:18.000Z (almost 3 years ago)
- Last Synced: 2024-10-03T23:59:32.672Z (about 1 month ago)
- Language: JavaScript
- Size: 27.3 KB
- Stars: 3
- Watchers: 4
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# nahsh-gtfs-rt-server
**Poll the [nah.SH](https://de.wikipedia.org/wiki/Nahverkehrsverbund_Schleswig-Holstein) [HAFAS endpoint](https://github.com/public-transport/hafas-client/tree/5/p/nahsh) to provide a [GTFS Realtime (GTFS-RT)](https://gtfs.org/reference/realtime/v2/) feed for Schleswig-Holstein & Hamburg.**
[](#license)
This project uses [`hafas-client`](https://github.com/public-transport/hafas-client) & [`hafas-gtfs-rt-feed`](https://github.com/derhuerst/hafas-gtfs-rt-feed) to fetch live data about all vehicles in the Schleswig-Holstein & Hamburg bounding box and build a live [GTFS Realtime (GTFS-RT)](https://developers.google.com/transit/gtfs-realtime/) feed from them.
## Installing & running
*Note*: [`hafas-gtfs-rt-feed`](https://github.com/derhuerst/hafas-gtfs-rt-feed), the library used by this project for convert for building the GTFS-RT feed, has more extensive docs. For brevity and to avoid duplication (with e.g. [`hamburg-gtfs-rt-server`](https://github.com/derhuerst/hamburg-gtfs-rt-server)), the following instructions just cover the basics.
### Prerequisites
`nahsh-gtfs-rt-server` needs access to a [Redis](https://redis.io/) server, you can configure a custom host/port by setting the `REDIS_URL` environment variable.
It also needs access to a [PostgreSQL](https://www.postgresql.org) 12+ server; Pass custom [`PG*` environment variables](https://www.postgresql.org/docs/12/libpq-envars.html) if you run PostgreSQL in an unusual configuration.
It also needs access to a [NATS Streaming](https://docs.nats.io/nats-streaming-concepts/intro) server (just follow its [setup guide](https://docs.nats.io/nats-streaming-server/run)); Set the `NATS_STREAMING_URL` environment variable if you run it in an unusual configuration.
```shell
git clone https://github.com/derhuerst/nahsh-gtfs-rt-server.git
cd nahsh-gtfs-rt-server
npm install
```
### Building the matching index
```shell
npm run build
```
The build script will download [the latest nah.SH GTFS Static data](#todo) and import it into PostgreSQL. Then, it will add [additional lookup tables to match realtime data with GTFS Static data](https://github.com/derhuerst/match-gtfs-rt-to-gtfs). [`psql`](https://www.postgresql.org/docs/current/app-psql.html) will need to have access to your database.
### Running
Specify the bounding box to be observed as JSON:
```shell
export BBOX='{"north": 55.0573747014, "west": 7.8685145620, "south": 53.3590675115, "east": 11.3132037822}'
```
`nahsh-gtfs-rt-server` uses [`hafas-gtfs-rt-feed`](https://github.com/derhuerst/hafas-gtfs-rt-feed) underneath, which is split into three parts: polling the HAFAS endpoint (`monitor-hafas` CLI), matching realtime data (`match-with-gtfs` CLI), and serving a GTFS-RT feed (`serve-as-gtfs-rt` CLI). You can run all three at once using the `start.sh` wrapper script:
```shell
./start.sh
```
In production, run all three using a tool like [`systemctl`](https://www.digitalocean.com/community/tutorials/how-to-use-systemctl-to-manage-systemd-services-and-units), [`forever`](https://github.com/foreversd/forever#readme) or [Kubernetes](https://kubernetes.io) that restarts them when they crash.
### via Docker
A Docker image [is available as `derhuerst/nahsh-gtfs-rt-server`](https://hub.docker.com/r/derhuerst/nahsh-gtfs-rt-server).
*Note:* The Docker image *does not* contain Redis, PostgreSQL & NATS. You need to configure access to them using the environment variables documented above (e.g. `NATS_STREAMING_URL`).
```shell
export BBOX='{"north": 55.0573747014, "west": 7.8685145620, "south": 53.3590675115, "east": 11.3132037822}'
# build the matching index
docker run -e BBOX -i -t --rm derhuerst/nahsh-gtfs-rt-server ./build.sh
# run
docker run -e BBOX -i -t --rm derhuerst/nahsh-gtfs-rt-server
```
### inspecting the feed
Check out [`hafas-gtfs-rt-feed`'s *inspecting the feed* section](https://github.com/derhuerst/hafas-gtfs-rt-feed/blob/master/readme.md#inspecting-the-feed).
### metrics
Check out [`hafas-gtfs-rt-feed`'s *metrics* section](https://github.com/derhuerst/hafas-gtfs-rt-feed/blob/master/readme.md#metrics).
## License
This project is dual-licensed: **My contributions are licensed under the [*Prosperity Public License*](https://prosperitylicense.com), [contributions of other people](https://github.com/derhuerst/nahsh-gtfs-rt-server/graphs/contributors) are licensed as [Apache 2.0](https://apache.org/licenses/LICENSE-2.0)**.
> This license allows you to use and share this software for noncommercial purposes for free and to try this software for commercial purposes for thirty days.
> Personal use for research, experiment, and testing for the benefit of public knowledge, personal study, private entertainment, hobby projects, amateur pursuits, or religious observance, without any anticipated commercial application, doesn’t count as use for a commercial purpose.
[Buy a commercial license](https://licensezero.com/offers/eb4289ed-952b-48d7-94ee-5820ea0f93e6) or read more about [why I sell private licenses for my projects](https://gist.github.com/derhuerst/0ef31ee82b6300d2cafd03d10dd522f7).