{"id":23739437,"url":"https://github.com/albinvar/Github-Telegram-Bot","last_synced_at":"2025-09-04T14:33:20.720Z","repository":{"id":55514653,"uuid":"313075087","full_name":"albinvar/Github-Telegram-Bot","owner":"albinvar","description":"A bot to send notifications from github directly to your Telegram account.","archived":false,"fork":false,"pushed_at":"2022-01-25T19:13:59.000Z","size":101,"stargazers_count":11,"open_issues_count":1,"forks_count":8,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-12-23T05:38:07.571Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","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/albinvar.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}},"created_at":"2020-11-15T16:36:18.000Z","updated_at":"2024-06-12T22:33:52.000Z","dependencies_parsed_at":"2022-08-15T02:10:38.606Z","dependency_job_id":null,"html_url":"https://github.com/albinvar/Github-Telegram-Bot","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/albinvar%2FGithub-Telegram-Bot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/albinvar%2FGithub-Telegram-Bot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/albinvar%2FGithub-Telegram-Bot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/albinvar%2FGithub-Telegram-Bot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/albinvar","download_url":"https://codeload.github.com/albinvar/Github-Telegram-Bot/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":231970925,"owners_count":18453924,"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":[],"created_at":"2024-12-31T09:36:53.447Z","updated_at":"2024-12-31T09:37:59.097Z","avatar_url":"https://github.com/albinvar.png","language":"PHP","funding_links":[],"categories":["PHP"],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e Github Telegram Bot\u003c/h1\u003e \u003cbr\u003e\r\n\u003cp align=\"center\"\u003e\r\n  \u003ca href=\"https://test.com\"\u003e\r\n    \u003cimg src=\"https://i.ibb.co/SxLvgjs/Bot-banner.png\" alt=\"logo\" width=\"190\" border=\"0\"\u003e\r\n  \u003c/a\u003e\r\n\u003cimg src=\"https://img.shields.io/github/repo-size/albinvar/Github-Telegram-Bot\"\u003e\r\n\u003ca href=\"LICENSE\"\u003e\u003cimg src=\"https://img.shields.io/apm/l/Github\"\u003e\u003c/a\u003e\r\n\u003c/p\u003e\r\n\r\nGithub Telegram Bot is a php bot for notifying Events from your github repository.\r\n\r\n## Table of Contents\r\n\r\n- [Introduction](#introduction)\r\n- [Features](#features)\r\n- [Screenshots](#screenshots)\r\n- [Installation](#installation-heroku)\r\n- [Contributing](#contributing)\r\n- [License](#license)\r\n\r\n## Introduction\r\n\r\nThis is the introduction section and a brief description is provided within this section.\r\n\r\n## Features \r\n\r\nGet Instant Notifications for \r\n\r\n- Pushes\r\n- Pull Request(open)\r\n- Comment\r\n- Issue(open)\r\n- Issue(close)\r\n- Merge\r\n\r\n### Create a New Bot\r\n1. Add [@BotFather](https://telegram.me/botfather) to start conversation.\r\n2. Type `/newbot` and **@BotFather** will ask the name for your bot.\r\n3. Choose a cool name, for example `My Github Bot` and hit enter.\r\n4. Now choose a username for your bot. It must end in *bot*, for example `GithubBot` or `Github_Bot`.\r\n5. If succeed, **@BotFather** will give you API key to be used in this bot.\r\n\r\n## Screenshots\r\n\u003cp align=\"center\"\u003e\r\n\u003cimg src=\"https://i.ibb.co/pxnY7Wf/ezgif-com-optimize.gif\" height=\"300\"\u003e\r\n\u003c/p\u003e\r\n\r\n## Installation (Heroku)\r\n\r\n\r\n0. Create a Account on [Heroku](https://heroku.com)\r\n\r\n1. Click `Create New App` in Heroku Dashboard\r\n\r\n2. Enter App Name and click on create app\r\n\r\n3. Now install Heroku CLI on your Computer [Instuctions](https://devcenter.heroku.com/articles/heroku-cli)\r\n\r\n4. Now open your terminal and run command `git clone https://github.com/albinvar/Github-Telegram-Bot.git`\r\n\r\n5. It will download Latest codes for you in your Device\r\n    \r\n6. Now change the directory to test using command `cd test`\r\n\r\n7. Now Login into Heroku CLI using command `heroku login -i` now enter your login details and hit Enter\r\n\r\n8. After Login run this command in terminal `heroku git:remote -a appName` here appName will be your app's name that you choose while creating the app.\r\n\r\n9. Now run follow commands in termial to install packages `heroku buildpacks:add heroku/php`\r\n\r\n10. Now run this command in your terminal `git push heroku master`, if this gives an error try this `git push -f heroku master`\r\n\r\n11. All done now it will take time to complete, after that you can visit your domain shown in terminal.\r\n\r\n## Installation on Heroku (Easy way)\r\nEasily deploy using the button below\r\n\r\n[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)\r\n\r\n## Installation (VPS/Localhost)\r\n\r\n1. Clone the repository using git. `git clone https://github.com/albinvar/Github-Telegram-Bot.git`\r\n\r\n2. Install all pacakges using composer. `composer install`\r\n\r\n3. Now change your directory using `cd Github-Telegram-Bot`\r\n\r\n4. Start a localhost using `php -S localhost:8080` \r\n\r\n5. You can setup your port-forwarding method. (Services like ngrok, serveo.net)\r\n\r\n## Setup Port-forwarding\r\n\r\n1. Install and Configure ngrok on your localmachine.\r\n\r\n2. Start Port-forwarding using the command `ngrok http 8080`\r\n\r\n3. Set the link with https as webhook using setWebhook.php \r\n\r\n4. You are good to go...\r\n\r\n## Set Webhook \r\n\r\n1. Open `http://YOUR_DOMAIN.COM/setWebhook.php` on your server/localhost.\r\n\r\n2. It will set your webhook based on the current server address for receiving calls from Telegram API. \r\n\r\n3. If you get a message saying \"webhook set successfully\". You are good to go....\r\n\r\n## Set webhook on Github\r\n\r\n1. Choose a repository on Github which you want to receive notifications. \r\n\r\n2. Direct to repo-settings-\u003ewebhooks-\u003eadd webhook\r\n\r\n3. Set the payload url ngrok/website link.\r\n\r\n4. Select `application/x-www-form-urlencoded` and select `All Events`\r\n\r\n5. Hit Enter and you will get all notifications from your Telegram bot\r\n\r\n```Note that : Your ngrok link will expire after sometimes. Using webhosting/vps is suggested```\r\n\r\n## Contributing\r\nPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.\r\n\r\n## License\r\nThis project is certified using [MIT License](https://github.com/albinvar/Github-Telegram-Bot/blob/main/LICENSE)\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falbinvar%2FGithub-Telegram-Bot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falbinvar%2FGithub-Telegram-Bot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falbinvar%2FGithub-Telegram-Bot/lists"}