Skip to content

Latest commit

 

History

History
21 lines (17 loc) · 1.31 KB

README.md

File metadata and controls

21 lines (17 loc) · 1.31 KB

Tzeva Adom Tracker

Spring Boot service that allows anyone to get real-time Tzeva Adom notifications by exposing an endpoint within their web appications.
The alert detection is provided by a separate library I wrote, which may be used on any Java project interested to get notifications.

Usage

To register an endpoint, one needs to register an account in order to get an API Token - which identifies their account.
Once a Tzeva Adom happens, a POST request is sent to all registered endpoints.
Every request contains an Authorization header with the user's API Token - without it the endpoint should ignore the request!

Example of request's payload:
image

Console Logging

Notifications are also logged to the console: image

  • When a registered endpoint cannot be notified(e.g. offline), the exact error is logged.

How to Install

The project uses Docker - so all you need to do is to download the latest image:
docker pull ghcr.io/davidtheexplorer/tzeva-adom-tracker:master
To run, create a container and expose the port 8080.