https://github.com/dcdunkan/show-json-bot
A simple bot to show JSON data of Telegram messages.
https://github.com/dcdunkan/show-json-bot
grammyjs show-json telegram-bot tg-devtools
Last synced: about 1 month ago
JSON representation
A simple bot to show JSON data of Telegram messages.
- Host: GitHub
- URL: https://github.com/dcdunkan/show-json-bot
- Owner: dcdunkan
- License: mit
- Created: 2021-10-02T18:14:48.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-05-09T18:38:19.000Z (almost 3 years ago)
- Last Synced: 2024-10-30T02:47:46.211Z (6 months ago)
- Topics: grammyjs, show-json, telegram-bot, tg-devtools
- Language: TypeScript
- Homepage: https://telegram.me/jsoonbot
- Size: 96.7 KB
- Stars: 24
- Watchers: 1
- Forks: 13
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-grammY - dcdunkan/show-json-bot - See the JSON data behind Telegram messages. [ᴜsᴇ](https://t.me/jsoonbot) (Bots)
README
Show JSON Bot
### Try the running bot here: [Show JSON Bot](https://telegram.me/jsoonbot)
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](https://telegram.me/JSONShowBot) which is **NOT** working as of
May 2, 2022 (Still a nope in Nov, 2024).
Re-written in [TypeScript](https://typescriptlang.org/) and now it runs on
[Deno](https://deno.land/).
- [Built Using](#built-using)
- [Setup](#setup) › [Running Locally](#running-locally)
- [Setup](#setup) › [Deno Deploy](#deno-deploy)
- [Setup](#setup) › [Environment Variables](#environment-variables)
This is a re-write. See the old version
[here](https://github.com/dcdunkan/show-json-bot/tree/node).
## Built Using
Thanks to these tools and libraries.
1. [grammY](https://grammy.dev) - The Telegram Bot Framework.
2. [Deno KV](https://deno.com/kv) - KV Database.
## Setup
### Running Locally
Make sure you have installed [Deno CLI](https://deno.land/).
- Clone the repository.
```bash
git clone https://github.com/dcdunkan/show-json-bot.git
```
- Change directory (`cd`) to the cloned repository.
- Run the bot using the command below.
```bash
DEBUG=1 BOT_TOKEN="" deno -E=BOT_TOKEN,DEBUG -N=api.telegram.org -I mod.ts
```
See the list of [environment variables](#environment-variables).
**Required permissions**
- `net` - To communicate with Telegram servers and receive updates.
- `env` - To access environment variables.
If everything is done correct, you should see "(Username) started" in your
console.
### Deno Deploy
The working bot, [@jsoonbot](https://telegram.me/jsoonbot) is currently deployed
on **[Deno Deploy](https://deno.com/deploy)**.
After deploying you will get a link to your application, in the format
`https://.deno.dev/`.
Open a browser and go to the link down below.
- Replace the `` with your `BOT_TOKEN`.
- Replace `` with the link to your application.
`https://api.telegram.org/bot/setWebhook?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 |
| ----------- | --------- | ------------------------------------------------------------------------------ |
| `DEBUG` | No. | If not set, the bot would run in the webhook mode. Set to enable long polling. |
| `BOT_TOKEN` | **Yes.** | The API token of the Bot. Chat with https://t.me/BotFather to get one. |
## License
This application is licensed under the MIT License. See the LICENSE file for
more information on copying and distributing this piece of software.
## 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](https://github.com/dcdunkan/show-json-bot/issues).
Or, open a [PQ](https://telegram.me/grammyjs/34358)!
---
Made with ❤️ and ☕
channel ~
public instance bot