You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Send GitHub notifications of your repositories to Telegram Bots, Groups, and Channels.
19
19
- The bot must be created using the [BotFather](https://core.telegram.org/bots#6-botfather)
20
20
21
-
## Features
21
+
## 🎉 Features
22
22
23
23
1.**GitHub Notifications to Telegram**: The package allows you to configure a Telegram bot to receive notifications from various GitHub events, including events like **commits, pull requests, issues, releases, and many more**.
24
24
25
+
<palign="center">
26
+
<imgalt="GitHub Notifications to Telegram"src="https://github.com/lbiltech/telegram-bot-github-notify/assets/35853002/462f330f-11d3-43ef-89cf-c70ade57b654" />
27
+
</p>
28
+
25
29
2.**Customize Notifications**: You can customize the types of notifications you want to receive through options on Telegram.
26
30
31
+
[//]: #(features image)
32
+
27
33
3.**Interactive Buttons**: The package supports creating interactive buttons on Telegram to perform actions such as enabling or disabling notifications.
28
34
35
+
[//]: #(features image)
36
+
29
37
4.**Event Management**: You can manage specific events that you want to receive notifications for, allowing you to focus on what's most important for your projects.
30
38
39
+
<palign="center">
40
+
<imgalt="Event Management to Telegram"src="https://github.com/lbiltech/telegram-bot-github-notify/assets/35853002/e217a2ad-49b5-4936-a2cd-fe4af66e2bfb" />
41
+
</p>
42
+
31
43
5.**Easy Integration**:
32
44
The package provides an API and user-friendly functions to create a Telegram bot and link it to your GitHub account.
33
45
34
-
## Requirements
46
+
[//]: #(features image)
47
+
48
+
## 📋 Requirements
35
49
36
50
- PHP ^8.0
37
51
- Composer
38
52
- Telegram Bot
39
53
40
-
## Installation
54
+
## ⚙ Installation
41
55
42
56
First, please clone and install this project via [Composer](https://getcomposer.org/):
**You need to set up your domain and SSL certificate to use the webhook**. You can build your own server or use a service like [Heroku](https://www.heroku.com/).
96
+
**We recommend that you use HTTPS to set up your domain and webhook.**
97
+
You can build your own server or use a service like [Heroku](https://www.heroku.com/).
83
98
84
-
In this example, we will use localhost and ngrok to set up the domain and webhook:
99
+
In this example, we will use localhost and [ngrok](https://ngrok.com/) to set up the domain and webhook:
85
100
1. Download and install [ngrok](https://ngrok.com/download).
86
-
2.Run command in terminal: `php -S localhost:8000`
87
-
3.Run command in terminal: `ngrok http 8000`
101
+
2.Go to this project directory and run command in terminal: `php -S localhost:8000`
102
+
3.Continue to run command in terminal: `ngrok http 8000`
88
103
4. Copy the HTTPS URL provided by ngrok and paste it into your `.env` file.
89
104
90
105
```shell
@@ -97,7 +112,9 @@ We have two ways to set the webhook:
97
112
98
113
#### 1. Set the webhook from this project
99
114
100
-
After setting up your domain and SSL certificate, you need to set up the webhook for your bot. Go to:
115
+
After setting up your domain and SSL certificate, you need to set up the webhook for your bot.
116
+
117
+
**Go to:**
101
118
102
119
```text
103
120
<APP_URL>/webhook/set.php
@@ -111,15 +128,17 @@ If you see the following message, it means that the webhook has been sent succes
111
128
{"ok":true,"result":true,"description":"Webhook was set"}
112
129
```
113
130
131
+
[//]: #(status image)
132
+
114
133
#### 2. Set the webhook manually from Telegram
115
134
116
135
If you want to set the webhook manually, you can use the following URL:
Now you can send a message to your bot, and you will receive a welcome message from the bot.
164
183
165
184
```text
166
185
/start
167
186
```
168
187
188
+
[//]: #(image)
189
+
169
190
If you want to check the menu, you can send the following message to your bot.
170
191
171
192
```text
172
193
/menu
173
194
```
174
195
175
-
At this point, the configuration process for your telegram bot is completed. You can use all the features of this bot.
196
+
🎊 **At this point, the configuration process for your telegram bot is completed. You can use all the features of this bot.** 🎉🎉
197
+
198
+
<palign="center">
199
+
<imgalt="Menu features of this bot"src="https://github.com/lbiltech/telegram-bot-github-notify/assets/35853002/5aa42173-9443-4978-a59a-82f2ed016790" />
200
+
</p>
176
201
177
202
Now you will need to add the Webhook for your GitHub repository to receive notifications.
178
203
179
-
## Add webhook on your GitHub repository to receive notifications
204
+
## 📌 Add webhook on your GitHub repository to receive notifications
180
205
181
206
1. Go to your repository settings
182
207
2. Go to the `Webhooks` section
@@ -189,7 +214,9 @@ Now you will need to add the Webhook for your GitHub repository to receive notif
0 commit comments