donkeyrit / friendly-spoon

🤖 Your Telegram Bot Name

This application is a Telegram bot that filters messages from other Telegram channels based on user-defined criteria. It is built using Java and integrates with the Telegram Database Library (tdlib) to receive messages from specific chats. The application is designed to be scalable and supports a large number of simultaneous interactions.

Architecture Overview

The application is structured around a microservices architecture, with the following main components:

• Bot Service: Handles interactions with the Telegram Bot API.
• Subscription Service: Manages user subscriptions to channels and uses tdlib to receive messages.
• Filter Service: Applies filters to messages and forwards filtered messages.
• Notification Service: Sends filtered messages to the user's Telegram bot.
• Database: Stores user subscriptions and filter criteria.
• Message Queue: Facilitates asynchronous communication between services (e.g., Apache Kafka).

Features

List the key features of your bot, such as:

• Subscribe to specific channels
• Filter messages based on criteria
• Receive only filtered messages
• [Add more features as needed]

Getting Started

Provide step-by-step instructions on how to set up and start using the bot.

1. Install the Bot: Explain how to add the bot to Telegram.
2. Subscribe to Channels: Guide users on how to subscribe to channels through the bot.
3. Set Up Filters: Describe how to set up filters for messages.
4. Receive Messages: Explain how users will receive filtered messages.

Usage

1. Interact with the Telegram bot to subscribe to channels and set up filters.
2. The bot will filter messages from the subscribed channels based on the criteria and send the filtered messages to your Telegram bot.

Contributing

Contributions are welcome! Please feel free to submit pull requests or open issues to improve the application.

License

Include the license information for your project.

Contact

Provide contact information or links to social media for users to reach out with questions or feedback.

---

Made with ❤️ by [Your Name](Your GitHub Profile Link) and contributors

friendly-spoon's Issues

[TEOTB-#61][DEV] Configure and deploy Kafka

[TEOTB-4][Dev-Ops] Prepare repository

Prepare GitHub repository for working.

• Add .gitignore;
• Add license file;
• Add README.md with base architecture overview;
• Clean solution (Remove .DS_Store files);
• Configure git (Use prefix for each commit).

[Dev] Create java project

The main purpose of this project is polling messages from telegram and save to AWS SQS queue.

• Create API project from maven archetype without spring;
• Configure Visual Studio Code;
• Add test endpoint.

[TEOTB-20][DEV] Add persistence storage for Telegram Bot

[TEOTB-26] Create middleware to extract messages from every chat

• Login to Telegram with provided phone number;
• Read messages from specific chat;
• Save authorisation state between runs;
• Filter messages by predefined rules;

[TEOTB-25] Implement feature for reading messages from open telegram bots

[TEOTB-26] Template

[TEOTB-8][DEV] Add logger

• Find options;
• Prepare comparison table;
• Use one powerful option;
• Use built-in logger.

[TEOTB-13][DEV] Create package for telegram bot core

• Rename root folder;
• Create sub-projects;
• Configure maven;
• Update dependency injection container;
• Create basic project.

[TEOTB-7][DEV] Add ability to handle list of commands

[TEOTB-18][Document] Create wiki page with roadmap and existing progress

[TEOTB-#58][DEV] Incorporate Telegram API Library

• Create a separate project for integration;
• Try to authorise with this new library;
• Get some messages from chats;
• Configure interface for interaction with this library;
• Incorporate this library to example.

[TEOTB-1][Dev] Create simple buildable java project

Implement simple telegram bot:

• Create java console application from maven archetype;
• Make it buildable through maven;
• Clean solution;
• Use config for token and bot username.

[TEOTB-12][DEV] Create the first package for Telegram Bot Core

• #27
• #28

[TEOTB-11][DEV] Update Telegram API Models

• Use enum for parse mode;
• Not use enum for venue;

[TEOTB-6][DEV] Implement event based system for receive updates

• Create simple synchronous version of bot;
• Fix some serialisation problems;
• Implement long polling.

[TEOTB-22][DEV-OPS] Delete snapshots versions after release or more 3.

[TEOTB-23][DEV-OPS] Create release GitHub workflow

[TEOTB-2][Dev] Prepare http client executor

• Create http client executor;
• Implement get and post methods;
• Parse json http response.

[TEOTB-19][DEV] Incorporate repeated tasks for bot

• Add functionality to create repeated tasks (for example: Send message when delivery date will close)

[TEOTB-5][Dev-Ops] Ready to Cloud-based solution

• Build application through Maven;
• Add pull-request builder within Github Actions.

[TEOTB-21][Document] Collect requirements for the next version of bot

[TEOTB-3][DEV] Add some Telegram Api Models

• #12
• Create story for performance testing;
• #13

[TEOTB-14][DEV-OPS] Configure GitHub to publish first version of package

[TEOTB-17][DEV] Create example telegram bot which use core logic from bot step father

• Add ability to set delivery country (currently only one);
• Extract delivery date for specific country;
• Check different date formats;
• Raise event in case date lest or equals 9 days;
• Add ability to set range number.

[TEOTB-24][DEV-OPS] Tech Debt #3

• Refactor workflows;
• Configure dependency between jobs;
• Try automate removing for new artifact.

[Dev-Ops] Configure local environment for Java project

Configure local environment for next development:

• Install Java 19;
• Configure JAVA_HOME folder;
• Intall Maven;
• Configure M2_HOME folder.

[TEOTB-16][DEV] Tech debt #2

• Add default settings for logger;
• Add ability to override settings for logger;
• Clean maven pom.xml files.
• Fix maven issue - Warning: Using platform encoding (UTF-8 actually) to copy filtered resources, i.e. build is platform dependent!
• Increment patch version during deploy.
• Retrieve information about merged pull-request.
• Remove branch after merge pull-request.

[TEOTB-10][DEV] Tech Debt

• Add logging on all levels;
• Create new design for event system;
• Filter received updates from telegram;
• Add proof of concept;
• Fix issue with storing offset value for update.

[TEOTB-9][DEV] Configure dependency injection container

• Create some comparison table;
• Choose dependency injection container;
• Add dependencies for result injection container;
• Incorporate injection container.