simono41/db-rest
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
No description
51 commits 1 branch 8 tags 307 KiB
JavaScript 97%
Dockerfile 3%
Find a file
Jannis R b83d89562d
restructure docs 📝, status badge
2020-10-04 19:47:49 +02:00
docs restructure docs 📝, status badge 2020-10-04 19:47:49 +02:00
lib merge /stations/all into /stations 2020-05-01 20:13:41 +02:00
routes Node 10+ 💥, db-hafas@3, update deps & dev deps 2020-05-01 20:13:45 +02:00
.dockerignore minor changes 2019-03-27 12:22:48 +01:00
.editorconfig init from vbb-rest 2017-10-24 23:28:12 +02:00
.gitignore render & serve API docs 2020-10-02 18:33:38 +02:00
api-docs.js generate API docs 📝 2020-05-01 20:13:45 +02:00
api.js restructure docs 📝, status badge 2020-10-04 19:47:49 +02:00
architecture.svg prepare for v5 2020-04-30 15:11:20 +02:00
Dockerfile improve Docker layer caching 2020-05-01 20:17:28 +02:00
index.js generate API docs 📝 2020-05-01 20:13:45 +02:00
license.md readme: mention Docker image 📝 2018-10-25 21:19:19 +02:00
package.json restructure docs 📝, status badge 2020-10-04 19:47:49 +02:00
readme.md restructure docs 📝, status badge 2020-10-04 19:47:49 +02:00

readme.md

db-rest

A clean REST API wrapping around the Deutsche Bahn HAFAS API. It is deployed at v5.db.transport.rest.

API Documentation

db-rest architecture diagram

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

installing & running

bvg-rest expects a Redis 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.

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

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

manually

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 or systemd.

Related Projects

  • vbb-rest – A clean REST API wrapping around the VBB API.
  • bvg-rest – A clean REST API wrapping around the BVG 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, found a bug or want to propose a feature, have a look at the issues page.