From 0cf6fbf82e1860cee18cc66ac5fc14ac95e97ca2 Mon Sep 17 00:00:00 2001 From: Lucid Kobold <72232219+LucidKobold@users.noreply.github.com> Date: Wed, 19 Feb 2025 17:03:49 -0500 Subject: [PATCH 1/5] Update readme --- README.md | 26 +++++++++++++++++++++----- 1 file changed, 21 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 99df345..9a86fca 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,8 @@ -

πŸ€– Telegram Bot Template

- - +# πŸ€– No Twitter Bot for [Lucid Creations Media The Cove](https://community.lucidcreations.media) Bot starter template based on [grammY](https://grammy.dev/) bot framework. -## Features +## Features of a grammY bot - Scalable structure - Config loading and validation @@ -23,13 +21,19 @@ Bot starter template based on [grammY](https://grammy.dev/) bot framework. - Runtimes: - [Bun](#bun-bunsh) +## Features of this bot + +- Obtain Group ID +- Delete Twitter/X links within whitelisted group +- Check if a group is in the whitelisted IDs + ## Usage Follow these steps to set up and run your bot using this template: 1. **Create a New Repository** - Start by creating a new repository using this template. You can do this by clicking [here](https://github.com/bot-base/telegram-bot-template/generate). + Start by creating a new repository using this template. You can do this by clicking [here](https://github.com/lucid-creations-media/no-twitter-bot/fork). 2. **Environment Variables Setup** @@ -45,6 +49,18 @@ Follow these steps to set up and run your bot using this template: Open the newly created `.env.bot.dev` and `.env.bot.prod` files and set the `BOT_TOKEN` environment variable. +3. **Remove references of LCM from your code.** + +Remove references of LCM fromm the following files: +project-root/ +β”œβ”€β”€ src +β”‚ β”œβ”€β”€ bot # Code related to bot +β”‚ β”‚ β”œβ”€β”€ features # Bot features +β”‚ β”‚ β”‚ β”œβ”€β”€helpCommand.ts +β”‚ β”‚ β”‚ └──isLCMGroup.ts +β”‚ └── └── index.ts # Bot entry point +└── README.md + 3. **Launching the Bot** You can run your bot in both development and production modes. -- 2.49.1 From db703e47de7f9f4cc8a13ba3892c5a5213189e95 Mon Sep 17 00:00:00 2001 From: Lucid Kobold <72232219+LucidKobold@users.noreply.github.com> Date: Wed, 19 Feb 2025 17:04:53 -0500 Subject: [PATCH 2/5] Update readme --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 9a86fca..96fd865 100644 --- a/README.md +++ b/README.md @@ -52,6 +52,8 @@ Follow these steps to set up and run your bot using this template: 3. **Remove references of LCM from your code.** Remove references of LCM fromm the following files: + +``` project-root/ β”œβ”€β”€ src β”‚ β”œβ”€β”€ bot # Code related to bot @@ -60,6 +62,7 @@ project-root/ β”‚ β”‚ β”‚ └──isLCMGroup.ts β”‚ └── └── index.ts # Bot entry point └── README.md +``` 3. **Launching the Bot** -- 2.49.1 From d9ab0ed797a3b3f619a05b1719b14fe51574d9c6 Mon Sep 17 00:00:00 2001 From: Lucid Kobold <72232219+LucidKobold@users.noreply.github.com> Date: Wed, 19 Feb 2025 17:05:27 -0500 Subject: [PATCH 3/5] Update readme --- README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 96fd865..6d55a0d 100644 --- a/README.md +++ b/README.md @@ -51,20 +51,20 @@ Follow these steps to set up and run your bot using this template: 3. **Remove references of LCM from your code.** -Remove references of LCM fromm the following files: + Remove references of LCM fromm the following files: -``` -project-root/ -β”œβ”€β”€ src -β”‚ β”œβ”€β”€ bot # Code related to bot -β”‚ β”‚ β”œβ”€β”€ features # Bot features -β”‚ β”‚ β”‚ β”œβ”€β”€helpCommand.ts -β”‚ β”‚ β”‚ └──isLCMGroup.ts -β”‚ └── └── index.ts # Bot entry point -└── README.md -``` + ``` + project-root/ + β”œβ”€β”€ src + β”‚ β”œβ”€β”€ bot # Code related to bot + β”‚ β”‚ β”œβ”€β”€ features # Bot features + β”‚ β”‚ β”‚ β”œβ”€β”€helpCommand.ts + β”‚ β”‚ β”‚ └──isLCMGroup.ts + β”‚ └── └── index.ts # Bot entry point + └── README.md + ``` -3. **Launching the Bot** +4. **Launching the Bot** You can run your bot in both development and production modes. -- 2.49.1 From 4ac499eebe90924c6d45db6445f75ff3abc52b88 Mon Sep 17 00:00:00 2001 From: Lucid Kobold <72232219+LucidKobold@users.noreply.github.com> Date: Wed, 19 Feb 2025 17:05:51 -0500 Subject: [PATCH 4/5] Update readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6d55a0d..57901a2 100644 --- a/README.md +++ b/README.md @@ -51,7 +51,7 @@ Follow these steps to set up and run your bot using this template: 3. **Remove references of LCM from your code.** - Remove references of LCM fromm the following files: + Remove references of LCM from the following files: ``` project-root/ -- 2.49.1 From d11ca6d0d7fb1ff0c405f4ac46a00ffae40be8e3 Mon Sep 17 00:00:00 2001 From: Lucid Kobold <72232219+LucidKobold@users.noreply.github.com> Date: Wed, 19 Feb 2025 17:08:02 -0500 Subject: [PATCH 5/5] Update package info --- package.json | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/package.json b/package.json index 90bface..82404ca 100644 --- a/package.json +++ b/package.json @@ -1,14 +1,14 @@ { - "name": "telegram-bot-template", + "name": "no-twitter-bot", "type": "module", - "version": "0.1.0", + "version": "1.0.1", "private": true, "packageManager": "yarn@1.22.19+sha1.4ba7fc5c6e704fce2066ecbfb0b0d8976fe62447", - "description": "Telegram bot starter template", + "description": "This grammY powered Telegram bot is designed to delete Twitter/X links and reformat services from whitelisted groups. This one is the main bot for the LCM Telegram groups/communities.", "imports": { "#root/*": "./build/src/*" }, - "author": "deptyped ", + "author": "Lucid Kobold (Lucid Creations Media) ", "license": "MIT", "engines": { "node": ">=20.0.0", -- 2.49.1