Git Product home page Git Product logo

everyone-bot-master's Introduction

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
/clean - Admin-only command to clean up inactive 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.
ENABLE_REMOVE_INACTIVE_MEMBERS_COMMAND Enables the experimental admin-only /clean command

License

MIT © Aquib Master

everyone-bot-master's People

Contributors

iamerosniko avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.