nestjs-telegraf/README.md
2023-07-23 16:39:41 +03:00

28 lines
1.3 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 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)
<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!
## Installation
```bash
$ npm i @maks1ms/nestjs-telegraf telegraf
```
## Documentation
Check out the [documentation site](https://nestjs-telegraf-maks1ms.vercel.app).