search

pustovitDmytro / sns-telegram-bot

Telegram transport for SNS notifications
MIT License
0 stars 1 forks source link
alarms aws notifications sns telegram telegram-bot

readme

sns-telegram-bot

Telegram transport for SNS notifications.

CodeFactor SonarCloud Codacy Total alerts Language grade Scrutinizer

Build Status Coverage Status Commit activity FOSSA License

Table of Contents

Requirements

Platform Status

To use library you need to have node and npm installed in your machine:

Package is continuously tested on darwin, linux and win32 platforms. All active and maintenance LTS node releases are supported.

Installation

Clone sources from GitHub, and install modules:

  git clone git@github.com:pustovitDmytro/sns-telegram-bot.git
  cd sns-telegram-bot
  npm install

Usage

pass configuration as env variables (.env files supported)

default values are in .env.defaults

run compiled version by:

  node lib/app.js

or sources by:

  npx babel-node runner.js

API Documentation

Check api-blueprint and swagger in docs folder or Github-pages

Community Bot

If you don't want to self-deploy, just use community bot @aws_sns_to_tg_bot. It does not store any data, so feel free to use it.

Contribute

Make the changes to the code and tests. Then commit to your branch. Be sure to follow the commit message conventions. Read Contributing Guidelines for details.