db-rest/readme.md

# db-rest

**A clean REST API wrapping around the [Deutsche Bahn HAFAS API](https://github.com/public-transport/db-hafas#db-hafas).** It is deployed at [`v5.db.transport.rest`](https://v5.db.transport.rest/).

[**API Documentation**](docs/index.md)

![db-rest architecture diagram](architecture.svg)

[![API status](https://badgen.net/uptime-robot/status/m784879516-8a977fa91b975fc3884a9857)](https://stats.uptimerobot.com/57wNLs39M/784879516)
[![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)
[![support me via GitHub Sponsors](https://img.shields.io/badge/support%20me-donate-fa7664.svg)](https://github.com/sponsors/derhuerst)
[![chat with me on Twitter](https://img.shields.io/badge/chat%20with%20me-on%20Twitter-1da1f2.svg)](https://twitter.com/derhuerst)


## installing & running

`bvg-rest` expects a [Redis](https://redis.io/) server running on `127.0.0.1:6379` (default port), but you can set the `REDIS_URL` environment variable to change this.

### via Docker

A Docker image [is available as `derhuerst/db-rest:5`](https://hub.docker.com/r/derhuerst/db-rest:5).

```shell
docker run -d -p 3000:3000 derhuerst/db-rest:5
```

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

### manually

```shell
git clone https://github.com/derhuerst/db-rest.git
cd db-rest
git checkout 5
npm install --production

redis-server &
npm start
```

To keep the API running permanently, use tools like [`forever`](https://github.com/foreverjs/forever#forever) or [`systemd`](https://wiki.debian.org/systemd).


## Related Projects

- [`vbb-rest`](https://github.com/derhuerst/vbb-rest) – A clean REST API wrapping around the VBB API.
- [`bvg-rest`](https://github.com/derhuerst/bvg-rest) – A clean REST API wrapping around the BVG API.
- [`hvv-rest`](https://github.com/derhuerst/hvv-rest) – A clean REST API wrapping around the HVV API.
- [`hafas-rest-api`](https://github.com/public-transport/hafas-rest-api) – Expose a HAFAS client via an HTTP REST API.
- [`hafas-client`](https://github.com/public-transport/hafas-client) – JavaScript client for HAFAS public transport APIs.


## 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).
-												init from vbb-rest

											
										
										
											2017-10-23 23:13:53 +02:00
+								# db-rest
-												prepare for v5

											
										
										
											2020-04-30 15:05:18 +02:00
+								**A clean REST API wrapping around the [Deutsche Bahn HAFAS API](https://github.com/public-transport/db-hafas#db-hafas).** It is deployed at [`v5.db.transport.rest`](https://v5.db.transport.rest/).
-												API documentation :memo:

											
										
										
											2017-12-16 11:47:03 +01:00
-												restructure docs 📝, status badge

											
										
										
											2020-10-04 13:46:14 +02:00
+								[**API Documentation**](docs/index.md)
-												init from vbb-rest

											
										
										
											2017-10-23 23:13:53 +02:00
-												minor changes

											
										
										
											2019-03-27 12:20:39 +01:00
+								![db-rest architecture diagram](architecture.svg)
-												update hafas-rest-api, architecture diagram :memo:

											
										
										
											2018-01-09 00:06:53 +01:00
-												restructure docs 📝, status badge

											
										
										
											2020-10-04 13:46:14 +02:00
+								[![API status](https://badgen.net/uptime-robot/status/m784879516-8a977fa91b975fc3884a9857)](https://stats.uptimerobot.com/57wNLs39M/784879516)
-												init from vbb-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)
-												readme: update badges, docs: improve url-encode note 📝

											
										
										
											2021-02-04 19:25:04 +01:00
+								[![support me via GitHub Sponsors](https://img.shields.io/badge/support%20me-donate-fa7664.svg)](https://github.com/sponsors/derhuerst)
 								[![chat with me on Twitter](https://img.shields.io/badge/chat%20with%20me-on%20Twitter-1da1f2.svg)](https://twitter.com/derhuerst)
-												init from vbb-rest

											
										
										
											2017-10-23 23:13:53 +02:00
-												improve readme :memo:

[ci skip]

											
										
										
											2019-06-11 13:56:21 +02:00
+								## installing & running
-												init from vbb-rest

											
										
										
											2017-10-23 23:13:53 +02:00
-												caching using cached-hafas-client

see also derhuerst/hvv-rest@8db740b

											
										
										
											2020-05-01 20:15:27 +02:00
+								`bvg-rest` expects a [Redis](https://redis.io/) server running on `127.0.0.1:6379` (default port), but you can set the `REDIS_URL` environment variable to change this.
-												improve readme :memo:

[ci skip]

											
										
										
											2019-06-11 13:56:21 +02:00
+								### via Docker
-												prepare for v5

											
										
										
											2020-04-30 15:05:18 +02:00
+								A Docker image [is available as `derhuerst/db-rest:5`](https://hub.docker.com/r/derhuerst/db-rest:5).
-												improve readme :memo:

[ci skip]

											
										
										
											2019-06-11 13:56:21 +02:00
 								```shell
-												prepare for v5

											
										
										
											2020-04-30 15:05:18 +02:00
+								docker run -d -p 3000:3000 derhuerst/db-rest:5
-												init from vbb-rest

											
										
										
											2017-10-23 23:13:53 +02:00
+								```
-												improve readme :memo:

[ci skip]

											
										
										
											2019-06-11 13:56:21 +02:00
-												caching using cached-hafas-client

see also derhuerst/hvv-rest@8db740b

											
										
										
											2020-05-01 20:15:27 +02:00
+								*Note:* The Docker image does not contain the Redis server.
-												improve readme :memo:

[ci skip]

											
										
										
											2019-06-11 13:56:21 +02:00
+								### manually
 								```shell
-												init from vbb-rest

											
										
										
											2017-10-23 23:13:53 +02:00
+								git clone https://github.com/derhuerst/db-rest.git
 								cd db-rest
-												prepare for v5

											
										
										
											2020-04-30 15:05:18 +02:00
+								git checkout 5
-												init from vbb-rest

											
										
										
											2017-10-23 23:13:53 +02:00
+								npm install --production
-												caching using cached-hafas-client

see also derhuerst/hvv-rest@8db740b

											
										
										
											2020-05-01 20:15:27 +02:00
 								redis-server &
-												init from vbb-rest

											
										
										
											2017-10-23 23:13:53 +02:00
+								npm start
 								```
-												minor docs fixes :memo:

closes #10

[ci skip]

											
										
										
											2019-08-07 23:21:01 +02:00
+								To keep the API running permanently, use tools like [`forever`](https://github.com/foreverjs/forever#forever) or [`systemd`](https://wiki.debian.org/systemd).
-												readme: mention Docker image :memo:

											
										
										
											2018-10-25 21:19:19 +02:00
-												init from vbb-rest

											
										
										
											2017-10-23 23:13:53 +02:00
-												rewrite docs, part 1 :memo:

											
										
										
											2020-05-01 18:51:03 +02:00
+								## Related Projects
 								- [`vbb-rest`](https://github.com/derhuerst/vbb-rest) – A clean REST API wrapping around the VBB API.
 								- [`bvg-rest`](https://github.com/derhuerst/bvg-rest) – A clean REST API wrapping around the BVG API.
 								- [`hvv-rest`](https://github.com/derhuerst/hvv-rest) – A clean REST API wrapping around the HVV API.
 								- [`hafas-rest-api`](https://github.com/public-transport/hafas-rest-api) – Expose a HAFAS client via an HTTP REST API.
 								- [`hafas-client`](https://github.com/public-transport/hafas-client) – JavaScript client for HAFAS public transport APIs.
-												init from vbb-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).