Giter Site home page Giter Site logo

hvv-rest's Introduction

hvv-rest

Deprecated because HVV has shut off hteir HAFAS API.


hvv-rest is a public transport REST API, a clean alternative to the HVV HAFAS API. It is deployed at v5.hvv.transport.rest.

API documentation

hvv-rest architecture diagram

API status ISC-licensed support me via GitHub Sponsors chat with me on Twitter

installing & running

hvv-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/hvv-rest:5.

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

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

manually

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

redis-server &
npm start

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

Related Projects

  • db-rest – A clean REST API wrapping around the Deutsche Bahn API.
  • vbb-rest – A clean REST API wrapping around the VBB API.
  • bvg-rest – A clean REST API wrapping around the BVG 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 or need support using hvv-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.

hvv-rest's People

Contributors

derhuerst avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.