Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/skrtdev/novagram
An Object-Oriented PHP library for Telegram Bots
https://github.com/skrtdev/novagram
api bot cli composer getupdates hacktoberfest mtproto oop php telegram telegram-api telegram-bot telegram-bots userbot webhooks
Last synced: 4 days ago
JSON representation
An Object-Oriented PHP library for Telegram Bots
- Host: GitHub
- URL: https://github.com/skrtdev/novagram
- Owner: skrtdev
- License: mit
- Created: 2020-06-21T16:00:29.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-09-01T15:05:07.000Z (over 1 year ago)
- Last Synced: 2025-01-10T13:35:06.303Z (11 days ago)
- Topics: api, bot, cli, composer, getupdates, hacktoberfest, mtproto, oop, php, telegram, telegram-api, telegram-bot, telegram-bots, userbot, webhooks
- Language: PHP
- Homepage: https://novagram.gaetano.eu.org/
- Size: 709 KB
- Stars: 181
- Watchers: 5
- Forks: 21
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
NovaGram
[](https://github.com/skrtdev/NovaGram/blob/master/LICENSE) [](https://github.com/skrtdev/NovaGram/stargazers) [](https://github.com/skrtdev/NovaGram/releases) [](https://packagist.org/packages/skrtdev/novagram) [](https://t.me/joinchat/JdBNOEqGheC33G476FiB2g)
An elegant, Object-Oriented, reliable PHP Telegram Bot Library
Full Documentation •
Public support group
Examples •
Features •
Installation
> **🌟 v1.9 has been released:** check changelog [here](https://github.com/skrtdev/NovaGram/blob/master/CHANGELOG.md#v19---source-code)
## ⚙️ Examples
An example code of a simple bot.
Works with both getUpdates and Webhooks
```php
use skrtdev\NovaGram\Bot;
use skrtdev\Telegram\Message;
$Bot = new Bot('YOUR_TOKEN');
$Bot->onCommand('start', function (Message $message) {
$message->reply('Hey! Nice to meet you. Use /info to know more about me.');
});
$Bot->onCommand('info', function (Message $message) {
$message->reply('Well, I\'m just an example, but you can learn more about NovaGram at novagram.gaetano.eu.org');
});
```
## 📎 Features
- ***Full***: All the Methods and Types implemented in *Bot Api 5.0* (support **local Bot Api** too)
- ***Fast***: Support for *JSON payload*, and *async handling of updates*
- ***Extendable***: With [Prototypes](https://novagram.gaetano.eu.org/prototypes.html), you can add your *custom functionalities*
- ***Easy***: *Exactly like original Bot Api*, with many methods simplified in a very nice way
- ***Ready***: You can *start creating your amazing bot right now*, thanks to many Built-in features, such as [Conversations](https://novagram.gaetano.eu.org/database.html), [Entities Parser](https://novagram.gaetano.eu.org/objects.html) and [getDC](https://novagram.gaetano.eu.org/docs.html#getUsernameDC)
- ***Secure***: When using Webhooks, there is a *Built-in Telegram IP Check*, that works with Cloudflare too!
### Why another PHP library?
I decided to build my own php library for telegram bot api because all the libraries i found on the web [made it difficult even to do the simplest things](docs/compare.md), such as a sendMessage.
NovaGram is built in order to bring a lightweight alternative to make bots, so that it is simple for beginners, but powerful for who already knows how to implement it.
## ⬇️ Installation
### Installation via [Composer](https://getcomposer.org)
Install NovaGram via Composer
```
composer require skrtdev/novagram ^1.9
```
After Installation, include NovaGram with:
```php
require 'vendor/autoload.php';
```
### Installation via Phar
Include the `phar` file in your bot file:
```php
if (!file_exists('novagram.phar')) {
copy('https://gaetano.eu.org/novagram/phar.phar', 'novagram.phar');
}
require_once 'novagram.phar';
```
More info in the [Documentation](https://novagram.gaetano.eu.org)