🤖 GitHubZipBot

💫 A powerful Telegram bot that downloads GitHub repositories as ZIP files with rich metadata

Features • Demo • Setup • Usage • Contact

✨ Features

Feature	Description
🔗 Smart URL Parsing	Accepts full GitHub URLs or owner/repo shorthand
📦 Zip Download	Downloads the default branch as a zip file instantly
📝 Rich Captions	Displays name, description, languages, stars, forks & more
📊 Language Breakdown	Beautiful percentage-based language composition
⚡ Live Progress	Real-time status updates while processing
🎨 Premium Emojis	Uses Telegram premium custom emojis for polish
⚠️ Error Handling	Friendly messages for invalid repos & rate limits
🚀 Lightning Fast	Optimized performance for quick downloads

🎬 Demo

🔥 See It In Action!

Simply send a GitHub repo link and get instant results:

You: https://github.com/expressjs/express

Bot: 📦 Downloading express...
     ⚡ Processing...
     ✅ Done! Sending file...

🛠 Setup

📋 Prerequisites

• Node.js v16 or higher
• A Telegram Bot Token (get from @BotFather)
• (Optional) GitHub Personal Access Token

1️⃣ Clone the repository

git clone https://github.com/vanshvx1-afk/GitHubZipBot
cd GitHubZipBot

2️⃣ Install dependencies

npm install

3️⃣ Configure environment variables

cp .env.example .env

Edit .env file:

BOT_TOKEN=your_telegram_bot_token_here
GITHUB_TOKEN=your_github_personal_access_token  # optional

💡 Pro Tip: GitHub token increases rate limit from 60 to 5,000 requests/hour!

4️⃣ Start the bot

npm start

🎉 Your bot is now live!

📖 Usage

🚀 Three Simple Steps

1. Open your bot on Telegram
2. Send a GitHub repository link:

   https://github.com/expressjs/express
   

   or use shorthand:

   expressjs/express
   

3. Receive the ZIP file with detailed metadata!

📦 Example Output

The bot sends a .zip file with a caption containing:

Info	Description
📦	Repository name
📝	Project description
🌐	Languages (with percentages)
⭐	Stars and 🔄 Forks
🌿	Branch info
📄	License type
💾	ZIP file size
🔗	Inline button to view on GitHub

📁 Project Structure

GitHubZipBot/
├── 📜 bot.js           # Main bot logic
├── 🔐 .env             # Environment variables (not committed)
├── 📋 .env.example     # Template for .env
├── 🚫 .gitignore       # Git ignore rules
├── 📦 package.json     # Dependencies
└── 📖 README.md        # You are here!

⚠️ Limitations

Limitation	Details
📤 File Size	50 MB max (Telegram limit)
🔒 Private Repos	Requires GitHub token with permissions
⏱️ Rate Limit	60/hr without token, 5000/hr with token

💡 For repos > 50MB, bot provides direct GitHub download link!

🤝 Connect With Me

📱 Let's Stay Connected!

📢 Join my Telegram channel: @botsarefather
💬 Contact me: @itsukiarai
🌐 Portfolio: vanshcz.online

📜 License

ISC License

Made with ❤️ by Vansh

⭐ Star this repo if you find it useful!

---