DEV Community

Alexander Kireev
Alexander Kireev

Posted on

Show your Telegram group member count in GitHub README

Hey folks! ๐Ÿ‘‹

Just released a simple tool to display your Telegram group/channel member count as a badge in your GitHub README.

๐Ÿš€ Quick Start

Add this to your README:

![Telegram](https://telegram-badge.vercel.app/api/telegram-badge?channelId=@your_channel)
Enter fullscreen mode Exit fullscreen mode

โœจ Features

  • Real-time member count
  • Multiple badge styles (flat, plastic, flat-square, for-the-badge, social)
  • Telegram logo support
  • Full customization (colors, labels)
  • Free hosting on Vercel

๐ŸŽจ Examples

Default:

https://telegram-badge.vercel.app/api/telegram-badge?channelId=@your_channel
Enter fullscreen mode Exit fullscreen mode

Custom style:

https://telegram-badge.vercel.app/api/telegram-badge?channelId=@your_channel&style=for-the-badge&label=Community
Enter fullscreen mode Exit fullscreen mode

No logo:

https://telegram-badge.vercel.app/api/telegram-badge?channelId=@your_channel&logo=false
Enter fullscreen mode Exit fullscreen mode

๐Ÿ›  Setup

  1. Create a Telegram bot via @BotFather
  2. Deploy to Vercel
  3. Add your BOT_TOKEN and CHAT_ID as environment variables
  4. Done! ๐ŸŽ‰

GitHub: telegram-badge

Built with TypeScript and โค๏ธ

telegram #github #opensource #typescript #badges #vercel #serverless

Top comments (0)