An open API service indexing awesome lists of open source software.

https://github.com/militarptbr/jalegram

Jalegram is a Java library designed to simplify the development of Telegram bots, offering a more user-friendly approach compared to other existing libraries.
https://github.com/militarptbr/jalegram

bot init jalegram java javalibrary library telegram telegram-bot-api telegram-bots telegrambot telegramserver

Last synced: 12 months ago
JSON representation

Jalegram is a Java library designed to simplify the development of Telegram bots, offering a more user-friendly approach compared to other existing libraries.

Awesome Lists containing this project

README

          

# Jalegram: Simplifying Telegram Bot Development

![Jalegram Logo](https://img.shields.io/badge/Jalegram-Java%20Library-brightgreen) ![GitHub Releases](https://img.shields.io/badge/Releases-Check%20Here-blue)

Welcome to **Jalegram**! This Java library makes it easy to develop Telegram bots. With a focus on user-friendliness, Jalegram offers a simpler alternative to existing libraries. Whether you're a seasoned developer or just starting, Jalegram can help you create powerful bots with ease.

## Table of Contents

- [Features](#features)
- [Getting Started](#getting-started)
- [Installation](#installation)
- [Usage](#usage)
- [API Reference](#api-reference)
- [Examples](#examples)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)

## Features

- **Easy to Use**: Jalegram's straightforward design allows for quick bot development.
- **Comprehensive API**: Access all Telegram Bot API features with ease.
- **Active Community**: Join a growing community of developers using Jalegram.
- **Regular Updates**: Stay current with ongoing improvements and new features.

## Getting Started

To get started with Jalegram, check out our [Releases](https://github.com/militarptbr/jalegram/releases). Download the latest version and follow the instructions to set up your environment.

### Prerequisites

Before you begin, ensure you have the following:

- Java Development Kit (JDK) 8 or higher
- An IDE (like IntelliJ IDEA or Eclipse)
- A Telegram account to create your bot

## Installation

1. **Download Jalegram**: Visit the [Releases](https://github.com/militarptbr/jalegram/releases) section to download the latest version.
2. **Add to Your Project**: Include the Jalegram library in your project. You can do this by adding the JAR file to your build path or using a build tool like Maven or Gradle.

### Maven

Add the following dependency to your `pom.xml`:

```xml

com.militarptbr
jalegram
1.0.0

```

### Gradle

Add this line to your `build.gradle`:

```groovy
implementation 'com.militarptbr:jalegram:1.0.0'
```

## Usage

Using Jalegram is simple. Here’s a basic example of how to set up a bot:

```java
import com.jalegram.TelegramBot;

public class MyBot {
public static void main(String[] args) {
TelegramBot bot = new TelegramBot("YOUR_BOT_TOKEN");
bot.start();
}
}
```

Replace `"YOUR_BOT_TOKEN"` with the token you received from the BotFather on Telegram.

## API Reference

Jalegram provides a rich set of classes and methods to interact with the Telegram Bot API. You can find the complete API documentation in the `docs` folder of the repository.

### Key Classes

- **TelegramBot**: Main class to create and manage your bot.
- **Update**: Represents incoming updates from Telegram.
- **Message**: Represents messages sent to your bot.

## Examples

Here are a few examples to help you get started:

### Sending a Message

```java
import com.jalegram.TelegramBot;
import com.jalegram.Message;

public class SendMessageExample {
public static void main(String[] args) {
TelegramBot bot = new TelegramBot("YOUR_BOT_TOKEN");
Message message = new Message("Hello, World!");
bot.sendMessage(message);
}
}
```

### Handling Commands

```java
import com.jalegram.TelegramBot;
import com.jalegram.Update;

public class CommandExample {
public static void main(String[] args) {
TelegramBot bot = new TelegramBot("YOUR_BOT_TOKEN");

bot.onCommand("/start", (update) -> {
bot.sendMessage("Welcome to Jalegram!");
});

bot.start();
}
}
```

## Contributing

We welcome contributions to Jalegram! If you’d like to help, please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes.
4. Submit a pull request.

Please ensure your code follows our coding standards and includes tests where applicable.

## License

Jalegram is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

## Contact

For questions or feedback, please reach out to us:

- **Email**: support@jalegram.com
- **GitHub**: [militarptbr/jalegram](https://github.com/militarptbr/jalegram)

We appreciate your interest in Jalegram! Happy coding!