https://github.com/devadathanmb/tldr-telegram-bot
Stop saying TLDR
https://github.com/devadathanmb/tldr-telegram-bot
Last synced: about 1 month ago
JSON representation
Stop saying TLDR
- Host: GitHub
- URL: https://github.com/devadathanmb/tldr-telegram-bot
- Owner: devadathanmb
- Created: 2023-09-04T05:07:39.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-10T08:23:52.000Z (about 2 years ago)
- Last Synced: 2024-01-11T10:39:46.337Z (about 2 years ago)
- Language: TypeScript
- Size: 17.6 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# TL;DR Bot
## Description
A Telegram bot designed to condense lengthy chat messages because life's too short for verbosity.
## Preview
## Where?
Please host the thing yourself. Because running this on my free tier VPS will put it on fire :)
## How to run this?
1. Make sure [Docker](https://www.docker.com/) and [Docker compose](https://docs.docker.com/compose/) is installed on your machine.
2. Clone the repository
```bash
git clone https://github.com/devadathanmb/tldr-bot.git
```
3. Create a `.env` file in the cloned directory and setup the environment variables (see [env.example](./env.example) for more info.) See [this](https://core.telegram.org/bots/tutorial) on how to setup a bot using [BotFather](https://telegram.me/BotFather).
4. Build and run the image using
```bash
cd tldr-bot/
docker compose up
```
That's it your bot should be live now!