nestjs-telegraf/README.md

28 lines
1.3 KiB
Markdown
Raw Normal View History

2023-07-23 16:39:41 +03:00
# NestJS Telegraf ![npm](https://img.shields.io/npm/dm/@maks1ms/nestjs-telegraf) ![GitHub last commit](https://img.shields.io/github/last-commit/maks1ms/nestjs-telegraf) ![NPM](https://img.shields.io/npm/l/@maks1ms/nestjs-telegraf)
2020-03-31 18:37:42 +03:00
2021-01-05 17:18:22 +03:00
<img align="right" width="95" height="148" title="NestJS logotype"
src="https://nestjs.com/img/logo-small.svg">
2021-01-05 17:18:22 +03:00
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.
2021-02-14 23:59:26 +03:00
- Full support of NestJS guards, interceptors, filters and pipes!
## Installation
```bash
2023-07-23 16:39:41 +03:00
$ npm i @maks1ms/nestjs-telegraf telegraf
2019-07-16 18:56:02 +03:00
```
2022-06-29 13:37:41 +03:00
## Documentation
2023-07-23 16:39:41 +03:00
Check out the [documentation site](https://nestjs-telegraf-maks1ms.vercel.app).