tiagossa1 / random-team-generator-tg-bot

Telegram bot created in NodeJS to randomize two football teams.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Welcome to Footbal Team Generator - Telegram Bot 👋

Version Documentation Maintenance License: ISC

Telegram bot to randomize two or more football teams.

Environment variables

  • TOKEN: Telegram bot token. For this token, create a bot using @BotFather on Telegram.
  • ALLOWED_IDS: List of user/chat ids that are allowed to use this bot. This list MUST be separated by a comma. To find your user ID, use @userinfobot on Telegram.
  • TEAM_PLAYERS: List of player names to generate the teams. This list MUST be separated by a comma.
  • GENERATE_COMMAND: Command keyword for generate command.
  • TIMEZONE: Time zone string. You can find here all of the time zones.
  • LANGUAGE: Full language code. e.g. en-US.
  • IS_PRODUCTION: Flag to know if the bot is running in a production environment. Needed for logs level.
  • DEFAULT_NUMBER_OF_TEAMS: Number of teams that the bot should generate if none is passed by the user. Default is 2.

Bot commands

  • /[GENERATE_COMMAND] [number of teams] [player names to ignore separated by space].

Install

npm install

Build

npm run build

Usage

npm run dev

Start

npm run start

Deploy

docker-compose up --build -d

Author

👤 Tiago Sá

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page. You can also take a look at the contributing guide.

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2023 Tiago Sá.
This project is ISC licensed.


This README was generated with ❤️ by readme-md-generator

About

Telegram bot created in NodeJS to randomize two football teams.

License:Apache License 2.0


Languages

Language:TypeScript 97.9%Language:Dockerfile 2.1%