https://github.com/Moldoteck/Beautifier

Bot that creates clean Telegraph pages from any link
https://github.com/Moldoteck/Beautifier

bot censorship censorship-circumvention censorship-free censorship-resistance mozilla readability telegram telegram-bot

Last synced: 2 months ago
JSON representation

Bot that creates clean Telegraph pages from any link

• Host: GitHub
• URL: https://github.com/Moldoteck/Beautifier
• Owner: Moldoteck
• License: mit
• Created: 2021-05-04T19:37:47.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2022-08-12T09:20:34.000Z (over 2 years ago)
• Last Synced: 2024-08-13T03:07:26.540Z (6 months ago)
• Topics: bot, censorship, censorship-circumvention, censorship-free, censorship-resistance, mozilla, readability, telegram, telegram-bot
• Language: TypeScript
• Homepage:
• Size: 170 KB
• Stars: 9
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
@BeautifierSimplifierBot

# Telegram bot which transforms any link in Instant View

Tired of slow web pages full of ads? Wouldn't be better if all links were **Instant View's**?. Well, this Bot can transform almost any link into an Instant View, keeping only meaningful information, **just forward a link to it**. If you add the bot to a group, it will try to transform any encountered link into an Instant View.

It uses Mozilla's Readability Tool for extracting web content and https://telegra.ph/ to host that new content.

_Just remember, Readability and Telegraph are not perfect. Readability **can skip some images/videos**. Telegraph **can't handle tables**. For those cases, each Telegraph article have link to original article in order to quickly switch to original web page._

Hopefully these drawbacks will be solved in the future by using Chrome's Readability engine and by generating images of tables for telegraph.

# Installation and local launch

1. Clone this repo: `git clone https://github.com/Moldoteck/Beautifier`

2. Launch the [mongo database](https://www.mongodb.com/) locally

3. Create `.env` with the environment variables listed below

4. Run `yarn install` in the root folder

5. Run `yarn develop`

And you should be good to go! Feel free to fork and submit pull requests. Thanks!

# Environment variables

- `TOKEN` — Telegram bot token

- `MONGO`— URL of the mongo database

- `TELEGRAPH_TOKEN`— Token for creating Telegraph pages. You can get it by calling appropiate API

Also, please, consider looking at `.env.sample`.

# License

MIT — use for any purpose. Would be great if you could leave a note about the original developers. Thanks!

Based on: https://github.com/backmeupplz/telegraf-template