Skip to content

Latest commit

 

History

History
275 lines (200 loc) · 13.3 KB

File metadata and controls

275 lines (200 loc) · 13.3 KB

Telegram Badge Generator

🇺🇸 English | 🇷🇺 Русский | 🇩🇪 Deutsch | 🇫🇷 Français | 🇪🇸 Español | 🇵🇹 Português | 🇸🇦 العربية | 🇯🇵 日本語 | 🇰🇷 한국어 | 🇨🇳 中文

Build Status Release npm version JSR npm bundle size TypeScript License: MIT

GitHub stars dev.to X (Twitter)

โปรเจ็กต์นี้สร้างป้าย SVG ที่แสดงจำนวนสมาชิกปัจจุบันของกลุ่มและช่อง Telegram ของคุณ เหมาะอย่างยิ่งสำหรับแสดงความคล่องแคล่วของชุมชนในไฟล์ README ของ GitHub หรือบนเว็บไซต์

เริ่มต้นอย่างรวดเร็ว

เพียงใช้พารามิเตอร์ URL เพื่อสร้างป้ายสำหรับกลุ่มหรือช่อง Telegram ใดๆ:

https://telegram-badge.vercel.app/api/telegram-badge?channelId=@your_channel_or_group

Telegram Group Members


เทคโนโลยีที่ใช้

  • Node.js / TypeScript
  • Telegram Bot API
  • Vercel (Serverless API)
  • Jest สำหรับการทดสอบ

วิธีใช้งาน

วิธีหลัก: พารามิเตอร์ URL (ไม่ต้องตั้งค่า!)

เพียงเพิ่ม ID กลุ่มหรือช่อง Telegram ของคุณไปยัง URL:

![Telegram Badge](https://telegram-badge.vercel.app/api/telegram-badge?channelId=@your_channel_or_group)

เอนทิตีที่รองรับ:

  • ช่องสาธารณะ (ตัวอย่าง: @your_channel)
  • กลุ่มสาธารณะ (ตัวอย่าง: @your_group)
  • กลุ่ม/ช่องส่วนตัว (ใช้ ID ตัวเลข: -1001234567890)

เพียงเท่านี้! ไม่ต้อง deploy ไม่ต้องใช้โทเค็นบอทสำหรับช่องและกลุ่มสาธารณะ

วิธีทางเลือก: โฮสต์ด้วยตนเอง

สำหรับผู้ใช้ขั้นสูงที่ต้องการโฮสต์อินสแตนซ์ของตนเอง:

1. ข้อกำหนดเบื้องต้น

  • โทเค็นบอท Telegram (สร้างผ่าน @BotFather)
  • บัญชี Vercel (หรือโฮสติ้ง Node.js ใดๆ)

2. Deploy ไปยัง Vercel

Deploy with Vercel

ตั้งค่าตัวแปรสภาพแวดล้อม:

  • BOT_TOKEN: โทเค็นบอท Telegram ของคุณ
  • CHAT_ID: ID แชทเริ่มต้น (ไม่จำเป็นหากใช้พารามิเตอร์ URL)

3. การพัฒนาในเครื่อง

git clone https://github.com/chatman-media/telegram-badge.git
cd telegram-badge
npm install

# สร้างไฟล์ .env
echo "BOT_TOKEN=your_bot_token" > .env
echo "CHAT_ID=@your_channel" >> .env

npm run dev

พารามิเตอร์การปรับแต่ง

คุณสามารถปรับแต่งรูปลักษณ์ของป้ายได้โดยใช้พารามิเตอร์ต่อไปนี้:

พารามิเตอร์ คำอธิบาย ค่าเริ่มต้น
channelId ID หรือชื่อผู้ใช้ของแชท Telegram (เช่น @timelinestudiochat) จากสภาพแวดล้อม
style รูปแบบป้าย flat
label ข้อความป้ายกำกับ Telegram
color สีป้ายหลัก 2AABEE (สี Telegram)
labelColor สีป้ายกำกับ 555555
logo แสดงโลโก้ Telegram true

รูปแบบที่ใช้ได้:

  • flat - รูปแบบเรียบ (เริ่มต้น)
  • plastic - รูปแบบพลาสติกกับไล่ระดับสี
  • flat-square - รูปแบบเรียบเหลี่ยมไม่มีมุมมน
  • for-the-badge - รูปแบบกว้างกับตัวพิมพ์ใหญ่
  • social - รูปแบบโซเชียลของ GitHub

ตัวอย่าง:

ป้ายมาตรฐาน (รูปแบบ flat):

https://telegram-badge.vercel.app/api/telegram-badge?channelId=@your_channel

Flat

ป้ายกับรูปแบบ plastic:

https://telegram-badge.vercel.app/api/telegram-badge?channelId=@your_channel&style=plastic

Plastic

ป้ายกับรูปแบบ flat-square:

https://telegram-badge.vercel.app/api/telegram-badge?channelId=@your_channel&style=flat-square

Flat-Square

ป้ายกับรูปแบบ for-the-badge:

https://telegram-badge.vercel.app/api/telegram-badge?channelId=@your_channel&style=for-the-badge

For-The-Badge

ป้ายกับรูปแบบ social:

https://telegram-badge.vercel.app/api/telegram-badge?channelId=@your_channel&style=social

Social

ป้ายกับป้ายกำกับและสีที่กำหนดเอง:

https://telegram-badge.vercel.app/api/telegram-badge?channelId=@your_channel&label=เข้าร่วมแชท&color=00FF00

Custom

ป้ายที่ปรับแต่งเต็มรูปแบบ:

https://telegram-badge.vercel.app/api/telegram-badge?channelId=@your_channel&style=for-the-badge&label=ชุมชน&color=FF5733&labelColor=1A1A1A

Full Custom

ป้ายไม่มีโลโก้:

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

No Logo

ป้ายสำหรับช่องเฉพาะ:

https://telegram-badge.vercel.app/api/telegram-badge?channelId=@your_channel

ป้ายกับการปรับแต่งที่กำหนดเอง:

https://telegram-badge.vercel.app/api/telegram-badge?channelId=@your_channel&style=for-the-badge&color=FF5733

คุณสมบัติ

  • 👥 แสดงจำนวนสมาชิกแบบเรียลไทม์
  • 🔗 พารามิเตอร์ URL โดยตรง - ไม่ต้องตั้งค่า!
  • 🎨 ปรับแต่งรูปลักษณ์ป้ายได้เต็มรูปแบบ
  • 🔒 โฮสต์ด้วยตนเองแบบเลือกได้กับการจัดเก็บโทเค็นอย่างปลอดภัย
  • ⚡ แคชที่ปรับปรุงแล้วสำหรับการโหลดที่รวดเร็ว
  • 🛡️ การจัดการข้อผิดพลาดกับข้อความที่ให้ข้อมูล
  • 🆓 ใช้งานฟรี
  • 📡 สามารถขยายเพื่อแสดงกิจกรรม/จำนวนข้อความ
  • 🧪 ชุดทดสอบที่ครอบคลุมกับ TypeScript

การใช้งาน API

เป็นแพ็คเกจ npm:

npm install telegram-badge
import badgeHandler from 'telegram-badge';

// ใช้ในเซิร์ฟเวอร์เลสฟังก์ชันของคุณ
export default badgeHandler;

การเรียก API โดยตรง:

GET /api/telegram-badge?style=flat&label=สมาชิก&color=2AABEE&labelColor=555555

การทดสอบ

รันแพ็คเกจทดสอบ:

npm test

รันการตรวจสอบประเภท:

npm run type-check

สร้างโปรเจ็กต์:

npm run build

การมีส่วนร่วม

  1. Fork รีพอซิทอรี
  2. สร้าง branch ฟีเจอร์ของคุณ (git checkout -b feature/amazing-feature)
  3. Commit การเปลี่ยนแปลงของคุณ (git commit -m 'Add some amazing feature')
  4. Push ไปยัง branch (git push origin feature/amazing-feature)
  5. เปิด Pull Request

ติดตาม

TikTok twitch YouTube Telegram X (Twitter)

สนับสนุน 💝🚀

  • BTC: 14s9Y9Rb2CUWHSAatiQMhfkpx1MWXofUzw
  • TON: UQD1M80nPyzph5ZW1vfp_r19XI5MaerNhDq4dWXbXCo96WFj
  • NOT: UQD1M80nPyzph5ZW1vfp_r19XI5MaerNhDq4dWXbXCo96WFj
  • ETH: 0x286D65151b622dCC16624cEd8463FDa45585fd60
BTC TON NOT ETH

ประวัติดาว

Star History Chart

กิจกรรมรีพอซิทอรี

Alt

ใบอนุญาต

โปรเจ็กต์นี้ได้รับอนุญาตภายใต้ใบอนุญาต MIT - ดูไฟล์ LICENSE สำหรับรายละเอียด


สร้างด้วย ❤️ โดย Chatman Media