Telego

<p align="center"> <a href="https://github.com/mitinarseny/telego"> <img src=".assets/logo.png" alt="telego logo" width="20%" /> </a> <h1 align="center">telego</h1> <p align="center">Docker Go template for creating <a href="https://core.telegram.org/bots">Telegram Bots</a> with clean architecture.</p> <p align="center"> <a href="https://travis-ci.org/mitinarseny/telego"><img alt="TravisCI" src="https://img.shields.io/travis/mitinarseny/telego/master.svg?style=flat-square&logo=travis-ci"></a> <a href="https://app.codacy.com/app/mitinarseny/telego"><img alt="Codacy" src="https://img.shields.io/codacy/grade/0702d21a638d4fa78328d988bdcedb19/master?style=flat-square&logo=codacy"></a> <a href="https://golangci.com/r/github.com/mitinarseny/telego"><img src="https://golangci.com/badges/github.com/mitinarseny/telego.svg"></a> <a href="/LICENSE.md"><img alt="Software License" src="https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square"></a> <a href="https://saythanks.io/to/mitinarseny"><img alt="SayThanks.io" src="https://img.shields.io/badge/say-thanks-9933ff.svg?style=flat-square"></a> </p> </p>

Table of Contents

• Usage
  • Create Bot
  • Copy Token
    • Notifier
  • Code
    • Logic
    • Handlers
  • Run
• Debug
  • Build & Run
  • Attach

Usage

Create Bot

Create new bot with @BotFather.

Copy Token

Create file ./docker-compose.secret.yaml with the following structure and paste the token from @BotFather:

# ./docker-compose.secret.yaml

version: '3.7'

services:
  bot:
    environment:
      TELEGO_BOT_TOKEN: "12345689:ABCdEFgHi1JKLMNO23P45rSTU6vw78xyz-a"

Notifier

You can enable Telegram notifications on your bot's status (UP or DOWN) by creating another bot and a group chat with this bot. Then edit ./docker-compose.secret.yaml:

# ...
environment:
  TELEGO_NOTIFIER_BOT_TOKEN: "<token>"
  TELEGO_NOTIFIER_CHAT_ID: "<chat_id>"

Code

Logic

Main logic of the bot should be implemented inside Configure function in bot/bot.go:

func Configure(b *tb.Bot) (*tb.Bot, error) {
    h := handlers.Handler{Bot: b}
    b.Handle("/hello", withLogMsg(h.HandleHello))
    return b, nil
}

func withLogMsg(handler func(*tb.Message) error) func(message *tb.Message) {
    return func(m *tb.Message) {
        if err := handler(m); err != nil {
            log.WithFields(log.Fields{
                "context": "BOT",
                "handler": handler,
            }).Error(err)
        }
    }
}

Handlers

All hanlders should be placed in bot/handlers/. Here is an example from hello.go:

func (b *Handler) HandleHello(m *tb.Message) error {
    _, err := b.Bot.Send(m.Sender, "Hello, world!")
    return err
}

Run

docker-compose \
  -f docker-compose.yaml \
  -f docker-compose.secret.yaml \
  up --build -d

Debug

You can debug your code with Delve debugger.

Build & Run

To enable dlv debugger inside the container run:

docker-compose \
  -f docker-compose.yaml \ 
  -f docker-compose.dev.yaml \
  -f docker-compose.secret.yaml \
  up --build -d

Attach

${GOPATH}/bin/dlv connect localhost:40000