Skip to content

Latest commit

 

History

History
62 lines (39 loc) · 2.66 KB

README.md

File metadata and controls

62 lines (39 loc) · 2.66 KB
Raw

vbb-rest

vbb-rest is a public transport REST API, a clean alternative to the VBB HAFAS API.

API documentation

vbb-rest architecture diagram

API status ISC-licensed support me via GitHub Sponsors chat with me on Twitter

installing & running

access to Redis

It is recommended that you let bvg-rest cache HAFAS responses within a Redis cache. To use this feature, set $REDIS_URL (e.g. to redis://localhost:6379/1 when running Redis locally).

via Docker

A Docker image is available as derhuerst/vbb-rest:6.

docker run -d -p 3000:3000 derhuerst/vbb-rest:6

Note: The Docker image does not contain the Redis server.

manually

git clone https://github.com/derhuerst/vbb-rest.git
cd vbb-rest
git checkout 6
npm install

export HOSTNAME='my-vbb-rest-api.example.org'
npm run build

redis-server &
npm start

To keep the API running permanently, use tools like forever or systemd.

Related Projects

  • vbb-modules – List of JavaScript modules for Berlin & Brandenburg public transport.
  • vbb-hafas – JavaScript client for the BVG HAFAS API.
  • bvg-rest – A clean REST API wrapping around the BVG API.
  • db-rest – A clean REST API wrapping around the Deutsche Bahn API.
  • hvv-rest – A clean REST API wrapping around the HVV API.
  • hafas-rest-api – Expose a HAFAS client via an HTTP REST API.
  • hafas-client – JavaScript client for HAFAS public transport APIs.

Contributing

If you have a question or have difficulties using vbb-rest, please double-check your code and setup first. If you think you have found a bug or want to propose a feature, refer to the issues page.