show-json-bot icon indicating copy to clipboard operation
show-json-bot copied to clipboard

A simple bot to show JSON data of Telegram messages.

Show JSON Bot

Try the running bot here: Show JSON Bot

A simple Telegram Bot to show JSON data of Telegram messages. The JSON data is the updates that Telegram sent to the bot. The bot also provides an UI to navigate through the JSON object. The workflow is highly inspired by JSONShowBot which is NOT working as of May 2, 2022.

Re-written in TypeScript and now it runs on Deno.

  • Built Using
  • SetupRunning Locally
  • SetupDeno Deploy
  • SetupEnvironment Variables

It's a re-write! See the old version: node/
https://github.com/dcdunkan/show-json-bot/tree/node

Built Using

Thanks to these tools and libraries.

  1. grammY - The Telegram Bot Framework.
  2. Deta.sh Base - Free and unlimited Cloud Database service.

Setup

Running Locally

Make sure you have installed Deno CLI.

  • Clone the repository.

    git clone https://github.com/dcdunkan/show-json-bot.git
    
  • Change directory (cd) to the cloned repository.

  • Create a .env file and set environment variables like in .env.example.

  • Run the bot using the command below.

    deno run --allow-net --allow-env --allow-read mod.ts
    

    Required permissions

    • --allow-net - To communicate with Telegram servers and receive updates.
    • --allow-env - To access environment variables.
    • --allow-read - To read .env file.

If everything is done correct, you should see "(Username) started" in your console.

Deno Deploy

The working bot, @jsoonbot is currently deployed on Deno Deploy (Beta).

Click the button to deploy to Deno Deploy.


Deploy to Deno Deploy

After deploying you will get a link to your application, in the format https://<appname>.deno.dev/.

Open a browser and go to the link down below.

  • Replace the <TOKEN> with your BOT_TOKEN.
  • Replace <APP_URL> with the link to your application.

https://api.telegram.org/bot<TOKEN>/setWebhook?url=<APP_URL>

This will set the bot's webhook to the deployed application, so that Telegram will sent further updates to there.

Environment Variables

Variable Required? Description
BOT_TOKEN Yes. The API token of the Bot. Chat with https://t.me/BotFather to get one.
DETA_KEY Yes. Project Key of Deta.sh Project. Sign up and create a project at https://deta.sh.

License

MIT License. Copyright (c) 2022 dcdunkan (Dunkan)

Contributing

Feel free to contribute! And if you are having issues or if you want suggest something, please open an issue here: dcdunkan/show-json-bot/issues. Or, open a PQ!


Made with ❤️ and ☕
channel ~ demo bot