Skip to content

mendab1e/telegram_meetup_bot

Repository files navigation

TelegramMeetupBot

Gem Version Build Status

Telegram bot for meetups organisation. It suits really well for small communities, where people want to attend a place together, but not on regular basis.

chat example

Available commands: /date, /list, /cancel, /cal, /help, /user

Installation

Install redis: http://redis.io/

Install the gem:

$ gem install telegram_meetup_bot

Usage

Register your bot and obtain a token

Run redis server:

$ redis-server

Generate sample configurations:

$ telegram_meetup_bot --generate

You should specify your bot_token and bot_name in ~/.telegram_meetup_bot/config.yml.

bot_token: 'insert your token here'
bot_name: 'meetup_dev_bot'
redis_host: 'localhost'
redis_port: '6379'
redis_key: 'meetup_bot'
botan_key: ''

The gem supports botan.io – free telegram analytics tool. All you have to do is obtain botan_key and specify it in config.yml.

If you use more than one bot per redis server, use different redis_keys for each of them.

Also you could change sample responses in ~/.telegram_meetup_bot/responses.yml. It uses templates %first_name% and %date% to display actual name and date in messages.

Run your bot:

$ telegram_meetup_bot

Contributing

  1. Fork it ( https://github.com/mendab1e/telegram_meetup_bot/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request