{"id":28274663,"url":"https://github.com/adarshkr357/dev-automators-telegram-bot","last_synced_at":"2025-06-16T08:31:21.696Z","repository":{"id":291397519,"uuid":"937216184","full_name":"adarshkr357/Dev-Automators-Telegram-Bot","owner":"adarshkr357","description":"🤖 Dev-Automators-Telegram-Bot is a community-driven Telegram bot that welcomes users and supports extensible commands. It offers webhook \u0026 long-polling support, making it flexible for automation. Open-source and beginner-friendly, it encourages collaboration while ensuring a professional and structured coding environment. 🚀✨","archived":false,"fork":false,"pushed_at":"2025-05-04T11:04:24.000Z","size":30758,"stargazers_count":1,"open_issues_count":0,"forks_count":39,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-21T02:12:07.584Z","etag":null,"topics":["automation","community-project","open-source","python","telegram-bot","telegram-bot-example"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/adarshkr357.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-02-22T16:02:14.000Z","updated_at":"2025-05-04T11:03:16.000Z","dependencies_parsed_at":"2025-05-04T12:19:14.979Z","dependency_job_id":"2acd71e0-6472-4bbb-995a-817d4ba3ddd6","html_url":"https://github.com/adarshkr357/Dev-Automators-Telegram-Bot","commit_stats":null,"previous_names":["adarshkr357/dev-automators-telegram-bot"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/adarshkr357/Dev-Automators-Telegram-Bot","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adarshkr357%2FDev-Automators-Telegram-Bot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adarshkr357%2FDev-Automators-Telegram-Bot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adarshkr357%2FDev-Automators-Telegram-Bot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adarshkr357%2FDev-Automators-Telegram-Bot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/adarshkr357","download_url":"https://codeload.github.com/adarshkr357/Dev-Automators-Telegram-Bot/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adarshkr357%2FDev-Automators-Telegram-Bot/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260126233,"owners_count":22962607,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["automation","community-project","open-source","python","telegram-bot","telegram-bot-example"],"created_at":"2025-05-21T02:11:50.766Z","updated_at":"2025-06-16T08:31:21.690Z","avatar_url":"https://github.com/adarshkr357.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# **Dev-Automators-Telegram-Bot**  \n\nWelcome to **Dev-Automators-Telegram-Bot** – a community-driven Telegram bot project!  \n\nThis bot is designed to greet users with a warm welcome and serve as a foundation for adding new, useful commands. We encourage open-source contributions to expand its capabilities while ensuring that all content remains legal, professional, and free from slang or inappropriate language.  \n\n## **Features**  \n\n- **Greeting Users:** The bot welcomes users as they join or interact.  \n- **Extensible Commands:** Community members can propose and add new commands.  \n- **Open Source Collaboration:** Follow our contribution guidelines to enhance the bot!  \n\n---\n\n## **How to Get Started**  \n\n### **1. Fork \u0026 Clone the Repository**  \n\nTo get started, fork [this](https://github.com/adarshkr357/Dev-Automators-Telegram-Bot) repository on GitHub and then clone it to your local system.  \n\n#### **Fork the Repository:**  \nClick the \"Fork\" button on this [repo](https://github.com/adarshkr357/Dev-Automators-Telegram-Bot) to create your own copy.  \n\n#### **Clone Your Fork:**  \nOpen a terminal and run the following command:  \n\n```bash\ngit clone https://github.com/\u003cyour-username\u003e/Dev-Automators-Telegram-Bot.git\ncd Dev-Automators-Telegram-Bot\n```  \n\n---\n\n### **2. Get Your Bot Token from BotFather**  \n\nTo run this bot, you'll need a bot token from Telegram's [BotFather](https://t.me/BotFather).  \n\n#### **Steps to Get Your Token:**  \n\n1. Open [BotFather](https://t.me/BotFather) in Telegram.  \n2. Start a chat and send the command `/newbot`.  \n3. Follow the prompts to set a name and username for your bot.  \n4. Once created, BotFather will provide you with a bot token in this format:  \n   ```plaintext\n   123456789:ABCDEFghijklmnopqrstuvwxyz\n   ```\n5. **Save this token**, as you will need it to run the bot.  \n\n---\n\n### **3. Set Up Your Environment**  \n\nOnce you have your bot token, create a `.env` file in the project directory (`Dev-Automators-Telegram-Bot` folder) and paste your bot token like this:  \n\n```plaintext\nBOT_TOKEN=123456789:ABCDEFghijklmnopqrstuvwxyz\n```\n\nThis ensures that your bot token remains secure and isn't exposed in the source code.  \n\n#### **Install Required Packages**  \n\nRun the following command to install all dependencies:  \n\n```bash\npip install -r requirements.txt\n```  \n\n---\n\n### **4. Set Up Ngrok for Webhooks (Not needed for now, skip it)**  \n\nIf your bot uses webhooks, you'll need to expose your local server to the internet using [Ngrok](https://ngrok.com/).  \n\n#### **1. Create an Ngrok Account**  \n\n- **Sign Up:**  \n  Visit: [Ngrok Signup](https://dashboard.ngrok.com/signup)  \n\n- **Email Verification \u0026 Details:**  \n  After verifying your Gmail, you'll be prompted to enter some details. Use the following:  \n  - *How would you describe yourself?* → Student / Hobbyist (Building for fun)  \n  - *What are you interested in using ngrok for?* → Testing Webhooks on local  \n  - *Are you using ngrok for?* → Development  \n\n- **Continue:**  \n  Click the **Continue** button to proceed.  \n\n#### **2. Download and Install Ngrok**  \n\n- **Choose Your Platform:**  \n  - For Windows users: [Download for Windows](https://dashboard.ngrok.com/get-started/setup/windows)  \n  - For macOS users: [Download for macOS](https://dashboard.ngrok.com/get-started/setup/macos)  \n  - For Linux users: [Download for Linux](https://dashboard.ngrok.com/get-started/setup/linux)  \n\n- **Download the Zip File:**  \n  Under the **Installation** section of the ngrok dashboard, click on the **Download** tab. A ZIP file will begin downloading.  \n\n- **Extract the File:**  \n  Extract the ZIP file. You will find a single file named `ngrok` (or `ngrok.exe` on Windows).  \n\n- **Move the File:**  \n  Cut and paste the `ngrok` file into your bot project's folder (`Dev-Automators-Telegram-Bot` folder).  \n\n- **Launch Ngrok:**  \n  Open the Ngrok application from your project folder.  \n\n#### **3. Configure Your Authentication Token**  \n\n- **Find Your Auth Token:**  \n  Go back to your Ngrok dashboard ([Ngrok Dashboard](https://dashboard.ngrok.com)) and locate the command under the **configuration** section. It will look similar to:  \n  ```bash\n  ngrok config add-authtoken \u003ctoken\u003e\n  ```\n- **Apply the Token:**  \n  Copy this command, paste it into the Ngrok terminal, and press **Enter**. (This is a one-time setup process.)  \n\n#### **4. Start Tunneling Your Local Server**  \n\n- **Open a Tunnel:**  \n  In your terminal, run the following command:  \n  ```bash\n  ngrok http 5000\n  ```\n  The **5000** port is set as the default. If your Flask (or similar) server is running on a different port, replace `5000` with the correct port number:  \n  ```bash\n  ngrok http \u003cPORT\u003e\n  ```\n  _(Replace `\u003cPORT\u003e` with the port your local server is using.)_  \n\nBy following these steps, you'll successfully set up **Ngrok** to expose your local development server. 🎉  \n\n---\n\n## **How to Contribute**  \n\nTo contribute, please follow our standard open-source workflow:  \n\n### **1. Create a New Branch**  \n\nAlways work on a new branch for your contribution.  \n\n```bash\ngit checkout -b add-new-command\n```  \n\n### **2. Read the Contribution Guidelines**  \n\nPlease review our [CONTRIBUTORS.md](./CONTRIBUTORS.md) for detailed instructions and the expected format for your contributions.  \n\n### **3. Make Your Changes**  \n\n- Update or add command functionality in the code.  \n- **Append your contribution** in the designated file (see below in the CONTRIBUTORS.md).  \n\n### **4. Commit and Push Your Changes**  \n\n```bash\ngit add .\ngit commit -m \"Added new command: [Your Command Name] -\u003e by [Your Name] - [Your Roll Number]\"\ngit push origin add-new-command\n```  \n\n### **5. Submit a Pull Request**  \n\nGo to your fork on GitHub and open a pull request to merge your changes into the main repository.  \n\n---\n\n## **Guidelines**  \n\n- **Be Professional:** All contributions must be legal and free from slang or inappropriate language.  \n- **Follow the Format:** Adhere to the guidelines provided in [CONTRIBUTORS.md](./CONTRIBUTORS.md) for adding your details or new commands.  \n- **Communication:** If you encounter any issues or have questions, please ask in the group.  \n\n---\n\nHappy contributing and happy coding! 🚀  \n— **DevInnovators Team**  \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadarshkr357%2Fdev-automators-telegram-bot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fadarshkr357%2Fdev-automators-telegram-bot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadarshkr357%2Fdev-automators-telegram-bot/lists"}