Skip to main content

Welcome to Easygram Documentation!

· One min read
Islom Mirsaburov
Easygram Creator

Welcome to the Easygram documentation site!

Easygram is a Spring Boot framework that makes building Telegram bots incredibly simple. No boilerplate, no configuration headaches—just pure, declarative bot logic.

What's Included​

  • 📚 Comprehensive Guides — From getting started to advanced patterns
  • 🚀 Quick Start — Build your first bot in 5 minutes
  • 🔧 Transport Guides — Long-polling, webhook, Kafka, RabbitMQ
  • 💡 Real Examples — Echo bot, registration wizard, producer bot, webhook bot
  • ❓ FAQ — Common questions and solutions

Key Features​

  • Zero-config autoconfiguration — Single property to start
  • Annotation-driven routing — @BotCommand, @BotText, @BotCallbackQuery, and more
  • Smart parameter injection — Inject User, Chat, Update, custom types
  • Pluggable transports — Switch between update sources with one property
  • Stateful workflows — Chat state management for multi-step flows
  • Fully customizable — Every bean is replaceable

Getting Started​

# Clone the repository
git clone https://github.com/oson-code/easygram.git

# Build locally
mvn clean install -DskipTests -Dgpg.skip=true

# Check out samples
cd samples
mvn package -DskipTests

Then head to Quick Start to build your first bot!

Community​

Happy bot building! 🤖