Skip to content

Commit 627d9f3

Browse files
morpheusadammorpheusadam
committed
docs: professional SEO-optimized README with badges
1 parent 16e9f87 commit 627d9f3

1 file changed

Lines changed: 160 additions & 131 deletions

File tree

‎README.md‎

Lines changed: 160 additions & 131 deletions
Original file line numberDiff line numberDiff line change
@@ -1,131 +1,160 @@
1-
![Screenshot 3](assets/images/media/3.jpg)
2-
3-
# Laravel Management Telegram Bot
4-
5-
This project is a Laravel-based application for managing Telegram groups using the TeleGroupBot software.
6-
7-
## Requirements
8-
9-
- PHP >= 7.3
10-
- MySQL >= 5.7
11-
- Composer
12-
- Node.js and npm (for frontend assets)
13-
14-
## Installation
15-
16-
1. Clone the repository:
17-
```sh
18-
git clone https://github.com/yourusername/laravel-management-telegram-bot.git
19-
cd laravel-management-telegram-bot
20-
```
21-
22-
2. Install PHP dependencies:
23-
```sh
24-
composer install
25-
```
26-
27-
3. Install Node.js dependencies:
28-
```sh
29-
npm install
30-
```
31-
32-
4. Copy the `.env.example` file to `.env` and configure your environment variables:
33-
```sh
34-
cp .env.example .env
35-
```
36-
37-
5. Generate the application key:
38-
```sh
39-
php artisan key:generate
40-
```
41-
42-
6. Run the database migrations:
43-
```sh
44-
php artisan migrate
45-
```
46-
47-
7. (Optional) Seed the database:
48-
```sh
49-
php artisan db:seed
50-
```
51-
52-
8. Compile the frontend assets:
53-
```sh
54-
npm run dev
55-
```
56-
57-
## Usage
58-
59-
To start the development server, run:
60-
61-
Visit `http://localhost:8000` in your browser to see the application.
62-
63-
## Features
64-
65-
- **Group Management**: Automate various tasks to manage your Telegram group efficiently.
66-
- **Privacy and Security**: Ensures the privacy and security of your group.
67-
- **Customizable**: Adapt the bot to the unique needs of your group.
68-
- **Advanced Message Filtering**: Automatically filter messages to maintain a clean and relevant discussion.
69-
- **Keyword Monitoring**: Censor specific words to keep the group respectful.
70-
- **Service Message Management**: Control service messages like "user joined" or "user left".
71-
- **New Member Restrictions**: Set restrictions for new members.
72-
- **Scheduled Messages**: Schedule messages to keep your group informed about upcoming events.
73-
- **Member Activity Insights**: Gain insights into member activity and interaction patterns.
74-
- **Ban and Mute Members**: Effectively manage problematic members.
75-
76-
## Contributing
77-
78-
If you would like to contribute to this project, please fork the repository and submit a pull request.
79-
80-
81-
## Contact
82-
83-
For any questions or support, please contact [yourname@example.com](mailto:yourname@example.com).
84-
85-
86-
87-
88-
![Screenshot 5](assets/images/media/6.png)
89-
90-
Visit `http://localhost:8000` in your browser to see the application.
91-
92-
## Features
93-
94-
- **Group Management**: Automate various tasks to manage your Telegram group efficiently.
95-
- **Privacy and Security**: Ensures the privacy and security of your group.
96-
- **Customizable**: Adapt the bot to the unique needs of your group.
97-
- **Advanced Message Filtering**: Automatically filter messages to maintain a clean and relevant discussion.
98-
- **Keyword Monitoring**: Censor specific words to keep the group respectful.
99-
- **Service Message Management**: Control service messages like "user joined" or "user left".
100-
- **New Member Restrictions**: Set restrictions for new members.
101-
- **Scheduled Messages**: Schedule messages to keep your group informed about upcoming events.
102-
- **Member Activity Insights**: Gain insights into member activity and interaction patterns.
103-
- **Ban and Mute Members**: Effectively manage problematic members.
104-
105-
## Screenshots
106-
107-
![Screenshot 1](assets/images/media/1.jpg)
108-
![Screenshot 2](assets/images/media/2.jpg)
109-
![Screenshot 4](assets/images/media/5.jpg)
110-
111-
## Contributing
112-
113-
If you would like to contribute to this project, please fork the repository and submit a pull request.
114-
115-
## License
116-
117-
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.
118-
119-
## Contact
120-
121-
For any questions or support, please contact [yourname@example.com](mailto:yourname@example.com).
122-
123-
## Repository
124-
125-
[GitHub Repository](https://github.com/morpheusadam/laravel-management-telegram-bot.git)
126-
127-
## 📞 Contact Me
128-
<div align="center">
129-
<a href="https://www.linkedin.com/in/hesam-ahmadpour" style="color: red; font-size: 20px; text-decoration: none;">LinkedIn</a> |
130-
<a href="https://t.me/morpheusadam" style="color: red; font-size: 20px; text-decoration: none;">Telegram</a>
131-
</div>
1+
<div align="center">
2+
3+
# 🤖 Laravel Telegram Group Management Bot
4+
5+
### A powerful **Laravel** application for automated **Telegram group management** (TeleGroupBot) — message filtering, keyword moderation, member controls, scheduled messages, and activity insights, with built-in subscriptions and multi-gateway payments.
6+
7+
<p>
8+
<img src="https://img.shields.io/github/license/morpheusadam/laravel-management-telegram-bot?style=for-the-badge&color=4c1" alt="License" />
9+
<img src="https://img.shields.io/github/stars/morpheusadam/laravel-management-telegram-bot?style=for-the-badge&color=ffca28" alt="Stars" />
10+
<img src="https://img.shields.io/github/forks/morpheusadam/laravel-management-telegram-bot?style=for-the-badge&color=42a5f5" alt="Forks" />
11+
<img src="https://img.shields.io/github/last-commit/morpheusadam/laravel-management-telegram-bot?style=for-the-badge&color=8e44ad" alt="Last commit" />
12+
<img src="https://img.shields.io/github/repo-size/morpheusadam/laravel-management-telegram-bot?style=for-the-badge&color=e67e22" alt="Repo size" />
13+
</p>
14+
15+
<p>
16+
<img src="https://img.shields.io/badge/Laravel-8.x-FF2D20?style=for-the-badge&logo=laravel&logoColor=white" alt="Laravel" />
17+
<img src="https://img.shields.io/badge/PHP-7.3%20%7C%208.x-777BB4?style=for-the-badge&logo=php&logoColor=white" alt="PHP" />
18+
<img src="https://img.shields.io/badge/Telegram-Bot%20API-26A5E4?style=for-the-badge&logo=telegram&logoColor=white" alt="Telegram" />
19+
<img src="https://img.shields.io/badge/MySQL-Database-4479A1?style=for-the-badge&logo=mysql&logoColor=white" alt="MySQL" />
20+
<img src="https://img.shields.io/badge/Redis-Queue-DC382D?style=for-the-badge&logo=redis&logoColor=white" alt="Redis" />
21+
<img src="https://img.shields.io/badge/Pusher-Realtime-300D4F?style=for-the-badge&logo=pusher&logoColor=white" alt="Pusher" />
22+
<img src="https://img.shields.io/badge/Tailwind-CSS-06B6D4?style=for-the-badge&logo=tailwindcss&logoColor=white" alt="Tailwind CSS" />
23+
</p>
24+
25+
</div>
26+
27+
---
28+
29+
## 📖 Overview
30+
31+
**Laravel Telegram Group Management Bot** (TeleGroupBot) is a comprehensive, Laravel-based solution for **automating and moderating Telegram groups**. It handles the day-to-day work of running a community — filtering spam, censoring keywords, managing service messages, restricting new members, scheduling announcements, and surfacing member-activity insights — so admins can keep their groups clean, safe, and engaged.
32+
33+
Beyond moderation, the project is built as a **SaaS-ready platform**: it includes a web dashboard, multilingual support, subscriptions/plans, QR-code generation, an update system, and integrations with a wide range of **payment gateways** (PayPal, Stripe, Razorpay, Mollie, Flutterwave, Paystack, Mercado Pago, Xendit, and more). Real-time events are powered by **Pusher**, queues by **Redis/Predis**, and storage can be backed by **AWS S3**.
34+
35+
It's ideal for **community managers, agencies, and developers** who want to offer Telegram group automation as a product or run it for their own communities.
36+
37+
> 🔎 **Keywords:** telegram bot, telegram group management, laravel telegram bot, telegroupbot, group moderation, message filtering, keyword censor, scheduled messages, community management, saas, subscription payments.
38+
39+
---
40+
41+
## ✨ Features
42+
43+
- 🛡️ **Group management** — automate routine tasks to run your Telegram group efficiently.
44+
- 🔒 **Privacy & security** — keep your group protected and well-moderated.
45+
- 🧩 **Customizable** — adapt the bot to the unique needs of each community.
46+
- 🚫 **Advanced message filtering** — automatically filter messages to keep discussion clean and relevant.
47+
- 🔤 **Keyword monitoring** — censor specific words to keep the group respectful.
48+
- 🔔 **Service-message management** — control "user joined" / "user left" and other service messages.
49+
- 👋 **New-member restrictions** — set limits and rules for newcomers.
50+
- ⏰ **Scheduled messages** — broadcast announcements and reminders on a schedule.
51+
- 📊 **Member activity insights** — understand engagement and interaction patterns.
52+
- 🔇 **Ban & mute** — effectively handle problematic members.
53+
- 🌍 **Multilingual** — built-in translation management.
54+
- 💳 **Subscriptions & payments** — multiple gateways (PayPal, Stripe, Razorpay, Mollie, and more).
55+
- 🔗 **Webhook-driven** — receive and process Telegram updates via webhook.
56+
57+
---
58+
59+
## 🛠️ Tech Stack
60+
61+
<p align="center">
62+
<img src="https://skillicons.dev/icons?i=laravel,php,mysql,redis,tailwind,aws,js" alt="Tech stack" />
63+
</p>
64+
65+
| Layer | Technologies |
66+
| --- | --- |
67+
| Backend | Laravel 8, PHP 7.3 / 8.x, Laravel Sanctum, Tinker |
68+
| Messaging | Telegram Bot API (webhook), Pusher (realtime) |
69+
| Queue & Cache | Redis / Predis |
70+
| Storage | AWS SDK, Flysystem S3 |
71+
| Frontend | Blade, Tailwind CSS, Alpine.js, Laravel Mix, SweetAlert2 |
72+
| Payments | PayPal, Stripe, Razorpay, Mollie, Flutterwave, Paystack, Mercado Pago, Xendit, Instamojo, Myfatoorah, Senangpay, Toyyibpay, Paymaya, Yoomoney |
73+
| Utilities | Simple QrCode, LaravelCollective HTML, Joe Dixon Translation |
74+
75+
---
76+
77+
## 🚀 Getting Started
78+
79+
### Prerequisites
80+
81+
- **PHP ≥ 7.3** (8.x recommended) with Composer
82+
- **MySQL ≥ 5.7**
83+
- **Node.js & npm** (for frontend assets)
84+
- A **Telegram bot token** (from [@BotFather](https://t.me/BotFather))
85+
86+
### Installation
87+
88+
```bash
89+
# 1. Clone the repository
90+
git clone https://github.com/morpheusadam/laravel-management-telegram-bot.git
91+
cd laravel-management-telegram-bot
92+
93+
# 2. Install dependencies
94+
composer install
95+
npm install
96+
97+
# 3. Create and configure your environment
98+
cp .env.example .env
99+
php artisan key:generate
100+
101+
# 4. Run migrations (and optionally seed)
102+
php artisan migrate
103+
php artisan db:seed # optional
104+
105+
# 5. Build assets
106+
npm run dev
107+
```
108+
109+
Start the server and open `http://localhost:8000`:
110+
111+
```bash
112+
php artisan serve
113+
```
114+
115+
> ⚙️ Configure your **Telegram bot token**, **database**, **Pusher**, and **payment gateway** credentials in `.env`, then point your bot's webhook to the app's webhook endpoint.
116+
117+
---
118+
119+
## 🗂️ Project Structure
120+
121+
```text
122+
laravel-management-telegram-bot/
123+
├── app/
124+
│ ├── Http/Controllers/ # Bot, Webhook, Dashboard, Subscription...
125+
│ ├── Providers/Payment/ # PayPal, Stripe, Razorpay, Mollie, ...
126+
│ ├── Models/ # Telegram_bot, Usage_log, User
127+
│ ├── Events/ # ChatEventPusherTelegram / Whatsapp
128+
│ └── Jobs/ # SendEmailJob
129+
├── .github/workflows/ # CI (php.yml)
130+
├── resources/ # Blade views & Tailwind assets
131+
└── routes/ # web, api & webhook routes
132+
```
133+
134+
---
135+
136+
## 🤝 Contributing
137+
138+
Contributions are welcome! Fork the repository and submit a pull request, or open an [issue](https://github.com/morpheusadam/laravel-management-telegram-bot/issues) with ideas and bug reports.
139+
140+
## 📜 License
141+
142+
Released under the **MIT License** — see the `LICENSE` file (or add one) for details.
143+
144+
---
145+
146+
<div align="center">
147+
148+
### 👤 Author — Morpheus Adam
149+
150+
Web developer & cheerful hacker · PHP · Laravel · Go
151+
152+
<p>
153+
<a href="https://github.com/morpheusadam"><img src="https://img.shields.io/badge/GitHub-morpheusadam-181717?style=for-the-badge&logo=github&logoColor=white" alt="GitHub" /></a>
154+
<a href="https://sam.zeonic.me"><img src="https://img.shields.io/badge/Website-sam.zeonic.me-4c1?style=for-the-badge&logo=googlechrome&logoColor=white" alt="Website" /></a>
155+
<a href="mailto:morpheusadam95@gmail.com"><img src="https://img.shields.io/badge/Email-Contact-D14836?style=for-the-badge&logo=gmail&logoColor=white" alt="Email" /></a>
156+
</p>
157+
158+
⭐ **If this bot helps you manage your Telegram community, please give it a star!** ⭐
159+
160+
</div>

0 commit comments

Comments
 (0)