<div align="center">
   <h1>
       <a href="#"><img src="https://nestgram.globalart.dev/img/logo.png" alt ="NestGram Logo"></a>
   </h1>
   🤖 A module for creating <b><a href="https://telegram.org/">Telegram</a> bots</b> using <a href="https://nestjs.com">NestJS</a>, based on <a href="https://telegraf.js.org/">Telegraf</a>
   <br/><br/>
   <a href="https://nestgram.globalart.dev">Documentation ✨</a> &emsp; <a href="https://github.com/GlobalArtInc/nestgram">Source code 🪡</a> &emsp; <a href="https://github.com/GlobalArtInc/nestgram/tree/master/examples">Examples 🛠️</a> &emsp; <a href="https://discord.gg/4Tc9hssSAv">Community 💬</a>
</div>

<br/>

<p align="center">
  <a href='https://img.shields.io/npm/v/@nestgramjs/core'><img src="https://img.shields.io/npm/v/@nestgramjs/core" alt="NPM Version" /></a>
  <a href='https://img.shields.io/npm/dm//@nestgramjs/core'><img src="https://img.shields.io/npm/dm/@nestgramjs/core" alt="NPM Downloads" /></a>
</p>

## About

This package uses the best of the NodeJS world under the hood. [Telegraf.js](https://github.com/telegraf/telegraf) is the most powerful
library for creating bots and [Nest.js](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. Flexible. Easy to use.
- Ability to create custom decorators.
- Interact with Telegram (Text Commands, Listeners).
- Full support of NestJS guards, interceptors, filters and pipes!

For questions and support please use
the [Issues](https://github.com/GlobalArtInc/nestgram/issues/new?assignees=&labels=question&template=question.yml).

## Installation

**Node.js 16.6.0 or newer is required.**

```bash
$ npm i @nestgramjs/core telegraf
$ yarn add @nestgramjs/core telegraf
$ pnpm add @nestgramjs/core telegraf
```
