dahmetal.js
v0.0.1
Published
A microservice to check whether Dahmetal bus traffic is affected by a strike.
Downloads
2
Readme
dahmetal.js
A microservice to check whether Dahmetal bus traffic is affected by a strike.
Dahmetal is a local traffic enterprise operating in Schleswig-Holstein, Germany. In September 2015, it has been affected by strikes on seemingly random days. This has annoyed a lot of people who depend on its busses, and has led to the creation of this project.
This project is a Walking Skeleton under development by Mark Tiedemann. The idea is to create a microservice to let users know whether a strike is happening. To determine this, the Dahmetal website is fetched and parsed.
A web app is currently under development as well. To notify mobile clients about upcoming strikes, Push Notifications via Google Cloud Messaging will be used.
Quickstart
To install the service, run:
npm install dahmetal.js
To start the service, run:
npm start -- <port>
To stop the service, run:
npm stop
To test the service, run:
npm test
To use the service, send a HTTP GET request; the response will look like this:
status: 200
body:
{
"available": true, // true if the Dahmetal website can be reached, else false
"striking": true // true if a strike is announced on the website, else false
}
License
The MIT License (MIT) as found in LICENSE.md.
Made with :heart:.