# alarmo

> Отправка уведомлений на telegram, viber по номеру телефона (через бота).

Latest version **19.1.1** (published 2019-01-06) · ISC license · 0 weekly downloads

## Install

```sh
npm install alarmo
pnpm add alarmo
yarn add alarmo
bun add alarmo
```

Provides the command `alarmo`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 19.1.1 |
| Published | 2019-01-06 |
| First published | 2018-11-12 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 14 |
| Unpacked size | 27.7 KB |
| Known vulnerabilities | 0 (+9 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 34 |
| Maintainers | antirek |

## Links

- npm: https://www.npmjs.com/package/alarmo
- Repository: https://github.com/antirek/alarmo
- Homepage: https://github.com/antirek/alarmo#readme
- Issues: https://github.com/antirek/alarmo/issues
- npm.io page: https://npm.io/package/alarmo

## Dependencies (14)

- [pug](https://npm.io/package/pug.md) ^2.0.0-rc.3
- [config](https://npm.io/package/config.md) ^1.26.2
- [tracer](https://npm.io/package/tracer.md) ^0.8.9
- [tslint](https://npm.io/package/tslint.md) ^5.12.0
- [express](https://npm.io/package/express.md) ^4.16.3
- [winston](https://npm.io/package/winston.md) 2.3.0
- [mongoose](https://npm.io/package/mongoose.md) ^4.13.17
- [telegraf](https://npm.io/package/telegraf.md) ^3.17.3
- [viber-bot](https://npm.io/package/viber-bot.md) ^1.0.13
- [body-parser](https://npm.io/package/body-parser.md) ^1.18.3
- [request-counter](https://npm.io/package/request-counter.md) 0.0.1
- [https-proxy-agent](https://npm.io/package/https-proxy-agent.md) ^2.2.1
- [express-basic-auth](https://npm.io/package/express-basic-auth.md) ^1.1.3
- [winston-console-formatter](https://npm.io/package/winston-console-formatter.md) 0.3.1

## Recent versions

- 19.1.1 (latest) — 2019-01-06
- 0.0.2 — 2018-11-12

## README

# alarmo

Отправка уведомлений на telegram, viber по номеру телефона (через бота).

[![Build Status](https://travis-ci.org/antirek/alarmo.svg?branch=master)](https://travis-ci.org/antirek/alarmo)

## Как работает?

Чат-бот (Telegram и/или Viber) принимает пользователя и спрашивает у него номер телефона. Затем полученный номер и соответсвующий id чата сохраняет на сервере. Теперь мы можем отправлять уведомление на номер, сделав простой http запрос, а бот будет направлять это уведомление соответствующему пользователю в его приложение (Telegram и/или Viber).


## Пример запроса

`````sh

curl -X POST \
  http://localhost:3030/send/89135292926 \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/json' \
  -d '{"text": "Ahtung!! Текст сообщения"}'

`````  


## Установка из репозитория github


> git clone https://github.com/antirek/alarmo.git

> cd alarmo

> npm install

> npm start


## Установка в docker

Используйте docker-compose.yml



## Конфиг

port - порт веб-интерфейса

mongodb - параметры подключения к mongodb

telegram - настройки чат-бота телеграм, получите у @botfather

viber - настройки чат-бота viber, получите в viber, также необходимо настроить домен для доступа к хуку viber.

---
_Source: https://npm.io/package/alarmo · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._