mirror of
https://github.com/Maks1mS/nestjs-telegraf.git
synced 2024-12-24 15:04:38 +03:00
🤖 Powerful Nest module for easy and fast creation Telegram bots
.github | ||
lib | ||
sample | ||
website | ||
.all-contributorsrc | ||
.eslintrc.js | ||
.gitignore | ||
.npmignore | ||
.prettierrc | ||
LICENSE.md | ||
package-lock.json | ||
package.json | ||
README.md | ||
tsconfig.json |
NestJS Telegraf
Documentation
If you want to dive fully into NestJS Telegraf then don't waste your time in this dump, check out the documentation site.
Installation
$ npm i nestjs-telegraf
Once the installation process is complete, we can import the TelegrafModule
into the root AppModule
:
import { Module } from '@nestjs/common';
import { TelegrafModule } from 'nestjs-telegraf';
@Module({
imports: [
TelegrafModule.forRoot({
token: 'TELEGRAM_BOT_TOKEN',
})
],
})
export class AppModule {}
Then add some decorators into the app.service.ts
for handling Telegram bot API updates:
import { Injectable } from '@nestjs/common';
import {
Start,
Help,
On,
Hears,
Context,
} from 'nestjs-telegraf';
@Injectable()
export class AppService {
@Start()
start(ctx: Context) {
ctx.reply('Welcome');
}
@Help()
help(ctx: Context) {
ctx.reply('Send me a sticker');
}
@On('sticker')
on(ctx: Context) {
ctx.reply('👍');
}
@Hears('hi')
hears(ctx: Context) {
ctx.reply('Hey there');
}
}
Support
Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please read more here.
People
- Authors - Aleksandr Bukhalo & Igor Kamyshev
- Maintainers - Aleksandr Bukhalo
- Website - https://nestjs.com
License
Nest is MIT licensed.
Contributors ✨
Thanks goes to these wonderful people (emoji key):
Eldar Salimzebarov 🐛 |
Vito Macchia 💻 🐛 |
KITAHARA SETSUNA 💻 🐛 |
Aleksandr Bukhalo 💻 📖 👀 |
Vyacheslav Saloid 🐛 |
This project follows the all-contributors specification. Contributions of any kind welcome!