https://github.com/losparviero/grammylog
Logging plugin for the grammY framework!
https://github.com/losparviero/grammylog
bot grammy grammy-plugin grammyjs log logging plugin telegram telegram-bot
Last synced: 13 days ago
JSON representation
Logging plugin for the grammY framework!
- Host: GitHub
- URL: https://github.com/losparviero/grammylog
- Owner: losparviero
- License: mit
- Created: 2023-03-18T20:30:19.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-08-24T17:42:25.000Z (almost 3 years ago)
- Last Synced: 2025-10-31T15:02:54.555Z (8 months ago)
- Topics: bot, grammy, grammy-plugin, grammyjs, log, logging, plugin, telegram, telegram-bot
- Language: JavaScript
- Homepage: https://npmjs.com/grammylog
- Size: 23.4 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# grammYLog
Logging plugin for the [grammY](https://github.com/grammyjs/grammy) framework!
### Features
1. Log messages received by your bot to console.
2. Log message content as well as first name, last name, username and Telegram ID of the sender.
3. Supports text and inline messages. In case of media messages, limited to captions.
4. For the future, db integrations are possible to implement persistent logs.
### Usage
Simply copy the plugin code from ```log.js``` and place it in your grammY project.
If you want to try it out first:
1. Firstly, clone this repo.
2. Then run ```npm i```.
3. Rename .env.example to .env and provide bot token.
4. Run the example with node example/echo
### Example
To use the example to see out how the plugin works:
```shell
node example/echo
```
### Template
A template has been included to get started right away.
To use the template:
```shell
node template/template
```
Modify it as per your needs.
### Contribute
If you'd like to contribute to the project, please read grammY's [guide to plugins](https://grammy.dev/plugins/guide.html).
### License
MIT ©️ Zubin