Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pedrosfaria2/telegram_assistant
A personal assistant telegram bot
https://github.com/pedrosfaria2/telegram_assistant
api backend conventional-commits ddd ddd-architecture ddd-patterns domain-driven-design javascript node node-js nodejs orm personal-assistant sequelize telegram telegram-bot telegram-bot-api utilities
Last synced: 15 days ago
JSON representation
A personal assistant telegram bot
- Host: GitHub
- URL: https://github.com/pedrosfaria2/telegram_assistant
- Owner: pedrosfaria2
- License: mit
- Created: 2024-10-31T00:48:45.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-11-03T22:19:12.000Z (3 months ago)
- Last Synced: 2024-11-09T22:07:40.264Z (2 months ago)
- Topics: api, backend, conventional-commits, ddd, ddd-architecture, ddd-patterns, domain-driven-design, javascript, node, node-js, nodejs, orm, personal-assistant, sequelize, telegram, telegram-bot, telegram-bot-api, utilities
- Language: JavaScript
- Homepage:
- Size: 88.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Personal Assistant Bot - Telegram Bot
This project is a personal assistant Telegram bot that assists users by providing reminders and other helpful functionalities. The bot is designed to offer a modular and scalable structure to support future features, making it ideal for evolving into a complete personal assistant tool.
## Project Overview
The main purpose of this project is to deliver an interactive personal assistant using the Telegram API, with the primary features being reminder management and shopping list management. Users can set reminders for specific dates and times, and manage shopping lists conveniently through the bot. The project leverages Domain-Driven Design (DDD) principles, which ensure a clear and organized code structure that is scalable and easy to maintain.
## Key Technologies
- **Node.js**: The project is built with Node.js for its powerful asynchronous capabilities and broad community support.
- **Telegram API**: The bot communicates with users over Telegram, providing an interactive and user-friendly interface.
- **Sequelize ORM**: Sequelize is used to manage database interactions, enabling a simple way to handle and query data.
- **Domain-Driven Design (DDD)**: The project follows DDD principles to create a structured and modular design that enhances maintainability and scalability.
- **Custom Logging with Chalk**: A customized logging class utilizing Chalk for colored and well-formatted logs.
## Telegram API Integration
To enable communication via Telegram, the bot utilizes the Telegram Bot API. You can create a new bot token for this project by following these steps:
1. **Create a Telegram Bot**: Start a chat with [BotFather](https://core.telegram.org/bots#botfather) on Telegram and follow the prompts to create a new bot.
2. **Retrieve the Token**: After creating the bot, BotFather will provide a unique bot token. This token will be used to authorize API requests.
3. **Configure the Token**: Store this token in a `.env` file under `TELEGRAM_TOKEN` for local development.
Example `.env` file:
```plaintext
TELEGRAM_TOKEN=your_bot_token_here
PORT=intport
DATABASE_URL=./reminders.db
```
## Features
### Current Features
- **Reminder Management**:
- **Set Reminder**: Users can set reminders for specific dates and times using the `/reminder` command.
- **View Agenda**: Users can see their agenda for the current or specific day using `/whats_the_day` command.
- **Upcoming Reminders**: Users can see their upcoming reminders using `/open_reminders` command.
- **Shopping List Management**:
- **Add Item**: Users can add an item to their shopping list using `/add_item` command.
- **Remove Item**: Users can remove an item from their shopping list using `/remove_item` command.
- **List Items**: Users can view all items in their shopping list using `/list_items` command. Items are displayed along with their status (purchased or not).
- **Mark as Purchased**: Users can mark an item as purchased using `/mark_purchased` command.
- **Unmark as Purchased**: Users can unmark an item as purchased using `/unmark_purchased` command.
- **Bulk remove**: Users can remove multiple items using `/bulk_remove` command.
### Planned Features
Planned improvements include additional functionalities that will help shape this bot into a comprehensive personal assistant. Upcoming features may incorporate integrations with Natural Language Processing (NLP) for better understanding and interaction capabilities, as well as additional productivity tools and integrations with various APIs.
## Setup & Installation
1. **Clone the Repository**:
```bash
git clone https://github.com/pedrosfaria2/telegram_assistant.git
cd telegram_assistant
```
2. **Install Dependencies**:
```bash
npm install
```
3. **Environment Setup**:
- Create a `.env` file in the root directory.
- Add your `TELEGRAM_TOKEN` and other necessary environment variables.
4. **Run the Bot**:
```bash
node src/main.js
```
## License
This project is licensed under the MIT License.