Skip to content

readme.md

Latest commit

 

History

History
46 lines (28 loc) · 1.79 KB

readme.md

File metadata and controls

46 lines (28 loc) · 1.79 KB
Raw

bvg-rest

bvg-rest is a public transport REST API, a clean alternative to the BVG HAFAS API.

API Documentation | Why?

bvg-rest architecture diagram

ISC-licensed chat with me on Gitter support me on Patreon

installing & running

via Docker

A Docker image is available as derhuerst/bvg-rest.

docker run -d -p 3000:3000 derhuerst/bvg-rest

manually

git clone https://github.com/derhuerst/bvg-rest.git
cd bvg-rest
git checkout 1
npm install --production
npm start

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

Related Projects

  • vbb-modules – List of JavaScript modules for Berlin & Brandenburg public transport.
  • bvg-hafas – JavaScript client for the BVG HAFAS API.
  • db-rest – A clean REST API wrapping around the Deutsche Bahn API.

Contributing

If you have a question or need support using bvg-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.