db-rest/readme.md
Jannis R 26994889f4
improve readme 📝
[ci skip]
2019-06-11 13:57:42 +02:00

1.5 KiB

db-rest

A clean REST API wrapping around the Deutsche Bahn API.

API Documentation | Why?

db-rest architecture diagram

Docker build status dependency status ISC-licensed gitter channel support me on Patreon

installing & running

via Docker

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

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

manually

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

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

Contributing

If you have a question, found a bug or want to propose a feature, have a look at the issues page.