Skip to content

Rust async API wrapper (reqwest) & TUI (ratatui) for Air Raid Alert Map of Ukraine

License

Notifications You must be signed in to change notification settings

voiceapiai/ralertsinua

This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

d2a4ea3 · May 18, 2024

History

13 Commits
May 12, 2024
May 18, 2024
May 17, 2024
May 12, 2024
May 18, 2024
May 5, 2024
May 18, 2024
May 18, 2024
May 18, 2024
May 17, 2024
May 18, 2024
May 5, 2024
May 17, 2024
May 5, 2024
May 5, 2024
May 12, 2024
May 12, 2024
May 18, 2024
May 18, 2024
May 18, 2024
May 18, 2024
May 18, 2024
May 8, 2024
May 5, 2024
May 5, 2024

Repository files navigation

Quality Gate Status Coverage Status Crates.io Version Crates.io License docs.rs

ralertsinua

Rust async API wrapper (reqwest) & TUI (ratatui) for alerts.in.ua

screencast

Introduction

The Alerts.in.ua API Client is a Rust library that simplifies access to the alerts.in.ua API service. It provides real-time information about air raid alerts and other potential threats.

Installation

Cargo

cargo install ralertsinua

Install prebuilt binaries via shell script

curl --proto '=https' --tlsv1.2 -LsSf https://github.com/voiceapiai/ralertsinua/releases/download/v0.5.0/ralertsinua-installer.sh | sh

Download prebuilt binaries from the releases page

Usage

⚠️ Before you can use this library, you need to obtain an API token by submitting an API request form.

⚠️ Provide token via environment variable ALERTSINUA_TOKEN or via --token flag. If empty, the library will try to ask you interactively one time.

export ALERTSINUA_TOKEN="your_token"; ralertsinua

# or

ralertsinua --token "your_token"

Default polling interval is 30 seconds. You can change it via ALERTSINUA_POLLING_INTERVAL_SEC env or --interval flag.

export ALERTSINUA_POLLING_INTERVAL_SEC=60; ralertsinua

# or

ralertsinua --interval 60

License

MIT 2024

Inspitation & Credits & Thanks

*[TUI]: Terminal User Interface