https://github.com/suddi/knightwatcherbot

Bot API for customized Telegram alerts, developed for AWS Lambda and API Gateway (https://bot.suddi.io)
https://github.com/suddi/knightwatcherbot

api-gateway aws-lambda claudiajs dynamodb functional-programming nodejs serverless telegram

Last synced: 2 months ago
JSON representation

Bot API for customized Telegram alerts, developed for AWS Lambda and API Gateway (https://bot.suddi.io)

• Host: GitHub
• URL: https://github.com/suddi/knightwatcherbot
• Owner: suddi
• License: apache-2.0
• Created: 2017-01-21T07:03:30.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2025-03-28T10:18:24.000Z (12 months ago)
• Last Synced: 2025-03-28T11:27:17.312Z (12 months ago)
• Topics: api-gateway, aws-lambda, claudiajs, dynamodb, functional-programming, nodejs, serverless, telegram
• Language: JavaScript
• Homepage: https://bot.suddi.io
• Size: 1.22 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 22
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# knightwatcherbot

[![CircleCI](https://circleci.com/gh/suddi/knightwatcherbot.svg?style=svg)](https://circleci.com/gh/suddi/knightwatcherbot)

[![codecov](https://codecov.io/gh/suddi/knightwatcherbot/branch/master/graph/badge.svg)](https://codecov.io/gh/suddi/knightwatcherbot)

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/462b2e476c1641b0ac4ade17a6064a8d)](https://www.codacy.com/app/Suddi/knightwatcherbot)

[![David](https://img.shields.io/david/suddi/knightwatcherbot.svg)](https://david-dm.org/suddi/knightwatcherbot)

[![David](https://img.shields.io/david/dev/suddi/knightwatcherbot.svg)](https://david-dm.org/suddi/knightwatcherbot?type=dev)

[![StackShare](https://img.shields.io/badge/tech-stack-0690fa.svg?style=flat)](https://stackshare.io/suddi/knightwatcherbot)

[![license](https://img.shields.io/github/license/suddi/knightwatcherbot.svg)](https://github.com/suddi/knightwatcherbot/blob/master/LICENSE)

[![codecov](https://codecov.io/gh/suddi/knightwatcherbot/branch/master/graphs/commits.svg)](https://codecov.io/gh/suddi/knightwatcherbot)

AWS Lambda function to get alerts via telegram for system alerts

## Installation

````

npm install

````

## Usage

To run the API locally:

````

npm start

````

To create the deployment with `claudia`:

````

claudia create --name  --region  --api-module lib

````

This will generate a config file named `claudia.json`

To deploy the same function afterwards to AWS Lambda:

````

claudia update

````

**NOTE:** `claudia` is a `devDependency` within this package, you will need to reference it within `node_modules` if it is not globally installed