Skip to main content

​
TelegrmBot API

Build intelligent Telegram bots with AI-powered responses and clean hexagonal architecture

Get StartedAPI Reference

​
Key Features

JWT Authentication

Secure user authentication with JSON Web Tokens

Telegram Integration

Seamless Telegram bot integration with polling

AI-Powered Responses

Generate intelligent responses using OpenRouter

Hexagonal Architecture

Clean, maintainable architecture with DDD principles

​
Quick Start

1

Clone and Configure

Clone the repository and set up your environment variables
git clone https://github.com/acamus79/TlgrmBot.git
cd TlgrmBot
cp .env.example .env
# Edit .env with your credentials
2

Run with Docker

Start the application using Docker Compose
docker-compose up --build
3

Access the API

The API will be available at http://localhost:8080Swagger documentation: http://localhost:8080/swagger-ui.html

​
Explore the Documentation

Introduction

Learn about the project and its capabilities

Installation

Set up your development environment

Architecture

Understand the hexagonal architecture design

Configuration

Configure environment variables and settings

Deployment

Deploy with Docker or locally

API Reference

Explore all available endpoints

​
Technology Stack

  • Java 21 - Modern Java features and performance
  • Spring Boot 3 - Enterprise-grade framework
  • PostgreSQL - Reliable relational database
  • JWT Security - Token-based authentication
  • Flyway - Database migration management
  • Docker - Containerized deployment
  • OpenRouter - AI model integration
  • Swagger/OpenAPI - Interactive API documentation

Build docs developers (and LLMs) love

Get started for freeTalk to us