franjsco
/
NotificamBot
mirror of https://github.com/franjsco/NotificamBot
1
0
Fork 0
Code Issues Releases Wiki Activity
19 Commits 6 Branches 0 Tags 556 KiB
JavaScript 92.2%
Dockerfile 7.8%
Go to file
dependabot[bot] 075489edd1
Bump cacheable-request and nodemon 
Removes [cacheable-request](https://github.com/jaredwray/cacheable-request). It's no longer used after updating ancestor dependency [nodemon](https://github.com/remy/nodemon). These dependencies need to be updated together.


Removes `cacheable-request`

Updates `nodemon` from 2.0.15 to 2.0.20
- [Release notes](https://github.com/remy/nodemon/releases)
- [Commits](https://github.com/remy/nodemon/compare/v2.0.15...v2.0.20)

---
updated-dependencies:
- dependency-name: cacheable-request
  dependency-type: indirect
- dependency-name: nodemon
  dependency-type: direct:development
...

Signed-off-by: dependabot[bot] <support@github.com>
 		2023-02-11 13:50:10 +00:00
src Update && add Dockerfile 2022-01-31 16:19:33 +01:00
.env.sample Update && add Dockerfile 2022-01-31 16:19:33 +01:00
.gitignore Initial version 2020-06-21 17:24:53 +02:00
Dockerfile Update && add Dockerfile 2022-01-31 16:19:33 +01:00
LICENSE Initial commit 2020-06-18 16:10:14 +02:00
README.md edit readme 2022-01-31 16:45:07 +01:00
docker-compose.yml Update && add Dockerfile 2022-01-31 16:19:33 +01:00
package-lock.json Bump cacheable-request and nodemon 2023-02-11 13:50:10 +00:00
package.json Bump cacheable-request and nodemon 2023-02-11 13:50:10 +00:00
test-publish.js Edit readme 2022-01-31 16:42:21 +01:00

README.md

NotificamBot

Telegram bot to receive notifications reads from a queue (pub/sub on Redis).

Configuration

Rename .env.sample in .env and configure it:

KEY DESCRIPTION
BOT_TOKEN Telegram Bot Token created with @BotFather
CHAT_ID Your chat id with the bot (you can configure this after the first launch of the bot from client)
REDIS_CHANELL Channel where the bot reads
REDIS_HOST Host redis (don't touch if you use docker-compose).
REDIS_PASSWORD Redis password

Usage

  1. Clone the project with
git clone https://github.com/franjsco/NotificamBot.git
  1. Build docker image and run it with docker-compose:
docker-compose up --build
  1. Search your bot on telegram and start it. The chat id will be displayed on the terminal. Copy it into .env and stop (CTRL+C) and start containers.
docker-compose up
  1. Now you can perform a test.
node test-publish.js
  1. You can send notifications to the bot by connecting to the container redis instance from any application and post messages to the configured queue.