Telegram bot to get everyone's attention in a group chat. Like @everyone in other messaging applications.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
controllers
domain
util
.gitignore
LICENSE.md
Procfile
README.md
circle.yml
config-sample.json
everyone-bot-logo.png
index.js
package.json
yarn.lock

README.md

Everyone bot logo
Everyone Bot

Telegram bot to get everyone's attention in a group chat. Like @everyone in other messaging applications.

Use

Use the hosted bot, or host your own!

Add to your group

Commands:

/start - Display help text
/in - Opt-in to receive mentions
/out - Opt-out of receiving mentions
/everyone - Mention all opted-in users

Installation

  • Clone the repository
  • Run npm install -g yarn if you haven't got yarn installed globally.
  • Run yarn install in the repository to install dependencies.
  • Create a config.json based on config-sample.json with the desired settings or setup the environment variables mentioned below.
  • Run npm start or npm start:dev to start the service.

Environment Variables

Name Description
TELEGRAM_API_KEY API key for the telegram bot, provided by @BotFather
BOT_USERNAME Username of the live bot on Telegram. Must be without the @ sign.
FIREBASE_PROJECT_NAME Firebase project to be used for storage of groups & users.
FIREBASE_DATABASE_SECRET Auth secret for Firebase to communicate securely.
MENTIONS_PER_MESSAGE Used to chunk the mentions into multiple messages as Telegram doesn't notify the people mentioned after the first 4 - 5.

License

MIT © Aquib Master