2017-10-23 23:13:53 +02:00
# db-rest
2017-12-16 11:47:03 +01:00
**A clean REST API wrapping around the [Deutsche Bahn ](https://en.wikipedia.org/wiki/Deutsche_Bahn ) [API ](https://github.com/derhuerst/db-hafas#db-hafas ).**
2017-12-16 11:47:21 +01:00
[API Documentation ](docs/index.md ) | [Why? ](docs/why.md )
2017-10-23 23:13:53 +02:00
2019-03-27 12:20:39 +01:00
![db-rest architecture diagram ](architecture.svg )
2018-01-09 00:06:53 +01:00
2019-03-27 12:20:39 +01:00
[![Docker build status ](https://img.shields.io/docker/build/derhuerst/db-rest.svg )](https://hub.docker.com/r/derhuerst/db-rest/)
2017-10-23 23:13:53 +02:00
[![dependency status ](https://img.shields.io/david/derhuerst/db-rest.svg )](https://david-dm.org/derhuerst/db-rest)
![ISC-licensed ](https://img.shields.io/github/license/derhuerst/db-rest.svg )
[![gitter channel ](https://badges.gitter.im/derhuerst/db-rest.svg )](https://gitter.im/derhuerst/db-rest)
2018-02-25 10:53:20 +01:00
[![support me on Patreon ](https://img.shields.io/badge/support%20me-on%20patreon-fa7664.svg )](https://patreon.com/derhuerst)
2017-10-23 23:13:53 +02:00
## Installing
```
git clone https://github.com/derhuerst/db-rest.git
cd db-rest
npm install --production
npm start
```
2018-10-25 21:19:19 +02:00
[A Docker image is available as `derhuerst/db-rest`. ](https://hub.docker.com/r/derhuerst/db-rest )
2017-10-23 23:13:53 +02:00
## Contributing
If you **have a question** , **found a bug** or want to **propose a feature** , have a look at [the issues page ](https://github.com/derhuerst/db-rest/issues ).