An open API service indexing awesome lists of open source software.

https://github.com/thewh1teagle/magen

Pikud Haoref Apps and API's
https://github.com/thewh1teagle/magen

alert israel pikudhaoref security

Last synced: 11 months ago
JSON representation

Pikud Haoref Apps and API's

Awesome Lists containing this project

README

          

# Magen

Apps and bots for Israel pikud haoref

# Available channels
Telegram channel which sends live alerts including a map image

- [Magen Telegram](https://t.me/MagenAlerts)

Interactive web based map for pikud haoref

- [Magen Web](https://thewh1teagle.github.io/Magen/)

# Contents of Repository

Core library written in Rust for interacting with pikud haoref
- [core/pikud](https://github.com/thewh1teagle/Magen/tree/main/core/pikud)

Rust based `ws` server which emits new alerts from pikud haoref

- [core/server](https://github.com/thewh1teagle/Magen/tree/main/core/server)

`NodeJS` API along with `React Native` App which uses `Firebase` for getting new alerts

- [mobile](https://github.com/thewh1teagle/Magen/tree/main/apps/mobile)

`React` based web application with interactive map, shows live alerts on the map

- [web](https://github.com/thewh1teagle/Magen/tree/main/apps/web)

`NodeJS` based telegram bot which sends live alerts to public channel along with dynamic map image

- [telegram-bot](https://github.com/thewh1teagle/Magen/tree/main/apps/telegram_bot)

# Build Containers
```shell
~/api docker compose -f docker-compose.dev.yaml build api
~/api docker compose -f docker-compose.dev.yaml push
``````

# Test
```
websocat -k wss://oref-rs.duckdns.org/ws_mock
```