eenagy / telegram-topics-bot

Telegram bot for creating event topics

Telegram bot for creating event topics

Description

Telegram bot for creating topics and voting for topics inside Telegram. Each topic can be claimed by a presenter, the presenter and group admins schedule a date for the topic to be presented.

The project uses

• Nest
• Nest-telegraf telegraf support for Nest.js

Installation

$ yarn install
# Remove local-session typing
$ rm node_modules/telegraf-session-local/lib/session.d.ts

Running the app

# development
$ yarn run start

# watch mode
$ yarn run start:dev

# debug flag for app
$ DEBUG='dappsbot' yarn run start:dev

# debug globally
$ DEBUG=* yarn run start:dev

# production mode
$ yarn run start:prod

Test

# unit tests
$ yarn run test

# e2e tests
$ yarn run test:e2e

# test coverage
$ yarn run test:cov

Telegram bot setup

Please follow the instructions at Telegram bot api to setup your own telegram bot. After you obtained a BOT API key, please create an .env file based on .env.example and replace the DAPPS_BOT_TOKEN with your obtained key.

No you can start your application either locally or deploy it to your own choosing.

Session FAQ

• State sync up
• Changing sessions to other supported ones

Supported commands

• /help
• /topics
• /request [topicsName]
• /submit [topicsName]
• /changeDescription
• /changeName
• /claim
• /schedule
• /vote