https://github.com/upsidedownsweetfood/tghelperbot

https://github.com/upsidedownsweetfood/tghelperbot

Last synced: 29 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/upsidedownsweetfood/tghelperbot
• Owner: upsidedownsweetfood
• Created: 2024-11-09T22:58:18.000Z (about 1 month ago)
• Default Branch: main
• Last Pushed: 2024-11-15T15:21:22.000Z (about 1 month ago)
• Last Synced: 2024-11-15T15:27:22.756Z (about 1 month ago)
• Language: TypeScript
• Size: 22.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Unnamed, modular Telegram helper bot

This bot was written to better manage a telegram meme channel, and I have decided to publish it, as I am extremely against properietary software, even in these circumnstances.

---

## How to run the project

First off, you need to use Deno as the typescript runtime.

You'll also need to set a few environment variables that are needed for the bot.

- BOT_API_ID

- BOT_API_TOKEN

- BOT_API_HASH

There are also a few reccomended ones.

- DATABASE_PATH

After that is done, you should probably run the migrations, the instructions on how to do that are available further below in the README.

Then, you should add yourself, or another telegram user to the Administrators and Users table in the database.

## Migrations

I didn't plan for the bot to have automatically generated migrations, if you make any change to the db structure, you will have to make and run a SQL script.

### Naming a new SQL script

As you may have noticed from the files in the migrations directory, the migrations are named with a prefix that has a skip of 10 digits.

I made it this way to have an overall ordinated list of migrations that won't cause issues in case you decide to add your own migrations.

Example.

The latest commit added a migration named __10_added_amongus_support.sql__, you may name your migration any number between 10(excluded) and (excluded)20.

### Running a migration

The way I'd run the migrations is this one.

```sh

cat migration_name | sqlite3 db_path

```

## QA

- Why did you make the bot this way?

    I'm a mentally ill faggot

- Why is there no automatic migration tool or ORM to ease with database operations?

    I'm not going to trust random projects that are likely to die in a month's time, or use too many NodeJS only libraries.

    I'm also against using a lot of external libraries.

---

This bot does not have a user agreement, or anything, but i'd personally like if this was not used in trans or LGBT hate groups.

Thanks.