mirror of
https://github.com/Maks1mS/nestjs-telegraf.git
synced 2024-12-27 08:18:08 +03:00
35 lines
1.7 KiB
Markdown
35 lines
1.7 KiB
Markdown
# NestJS Telegraf ![npm](https://img.shields.io/npm/dm/nestjs-telegraf) ![GitHub last commit](https://img.shields.io/github/last-commit/bukhalo/nestjs-telegraf) ![NPM](https://img.shields.io/npm/l/nestjs-telegraf)
|
||
|
||
<img align="right" width="95" height="148" title="NestJS logotype"
|
||
src="https://nestjs.com/img/logo-small.svg">
|
||
|
||
NestJS Telegraf – powerful solution for creating Telegram bots.
|
||
|
||
This package uses the best of the NodeJS world under the hood. [Telegraf](https://github.com/telegraf/telegraf) is the most powerful library for creating bots and [NestJS](https://github.com/nestjs) is a progressive framework for creating well-architectured applications. This module provides fast and easy way for creating Telegram bots and deep integration with your NestJS application.
|
||
|
||
**Features**
|
||
|
||
- Simple. Easy to use.
|
||
- Ton of decorators available out of the box for handling bot actions.
|
||
- Ability to create custom decorators.
|
||
- Scenes support.
|
||
- Telegraf plugins and custom plugins support.
|
||
- Ability to run multiple bots simultaneously.
|
||
- Full support of NestJS guards, interceptors, filters and pipes!
|
||
|
||
**User stories**
|
||
- [Новогодняя история одного телеграм-бота на NestJS](https://habr.com/ru/company/tinkoff/blog/596287/) by [Tinkoff Bank](https://github.com/Tinkoff)
|
||
- [The story of the creation of the personal telegram bot (40 articles!)](https://dev.to/endykaufman/i-decided-to-try-to-keep-a-twitter-history-of-rewriting-one-of-the-projects-im-starting--1e6p) by [@EndyKaufman](https://github.com/EndyKaufman)
|
||
|
||
**Chat**
|
||
|
||
* [Telegram](https://t.me/nestjs_telegraf)
|
||
## Installation
|
||
|
||
```bash
|
||
$ npm i nestjs-telegraf telegraf
|
||
```
|
||
|
||
## Documentation
|
||
Check out the [documentation site](https://nestjs-telegraf.hypeer.company).
|