https://github.com/ponomarevlad/tinytimerbot
https://github.com/ponomarevlad/tinytimerbot
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ponomarevlad/tinytimerbot
- Owner: PonomareVlad
- Created: 2023-06-19T13:14:43.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-20T03:54:23.000Z (over 1 year ago)
- Last Synced: 2025-02-05T07:13:20.254Z (4 months ago)
- Language: JavaScript
- Homepage: https://t.me/TinyTimerBot
- Size: 37.1 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Telegram Bot Template for [Vercel Edge Functions](https://vercel.com/docs/concepts/functions/edge-functions) with [streaming response](https://vercel.com/docs/concepts/functions/edge-functions/streaming)
> 📖 [Documentation for grammY](https://grammy.dev)
## How to Use
You can choose from one of the following two methods to use this repository:
### One-Click Deploy
Deploy the template using [Vercel](https://vercel.com):
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FPonomareVlad%2FgrammYVercelEdgeStream&env=TELEGRAM_BOT_TOKEN&envDescription=Telegram%20Bot%20Token%20from%20%40BotFather&envLink=https%3A%2F%2Fcore.telegram.org%2Fbots%2Ftutorial%23obtain-your-bot-token&project-name=grammy-vercel-edge-stream&repository-name=grammy-vercel-edge-stream)
### Clone and Deploy
Select the appropriate option and deploy it to the cloud with [Vercel](https://vercel.com/new)
#### As Vercel project
> Please note that you will need to create a Vercel project and [set the bot token](#as-local-project) in the settings
##### Using long polling
```bash
npm run polling
```
##### Using webhook with [CloudFlare tunnel](https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/do-more-with-tunnels/trycloudflare/) ([`cloudflared`](https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/install-and-setup/installation/)) :
```bash
npm run webhook
```
And open link from terminal (ends with `*.trycloudflare.com`) to set webhook URL
> If you want another tunnel, just use [`vercel dev`](https://vercel.com/docs/cli/dev)
#### As local project
Set environment variable or create `.env` file:
```dotenv
TELEGRAM_BOT_TOKEN="Telegram Bot Token from t.me/BotFather"
```
Run in long polling mode:
```bash
npm run start
```
> 💡 This command does not require a Vercel account or CLI installation to run
## Template structure
- [src/bot.mjs](src/bot.mjs) — Bot initialization and logic
- [src/data.mjs](src/data.mjs) — Data source for bot modules
- [src/start.mjs](src/start.mjs) — Starts bot in long polling mode
- [src/build.mjs](src/build.mjs) — Sets webhook and saves bot info
- [api/update.mjs](api/update.mjs) — Function for receiving webhooks
- [api/webhook.mjs](api/webhook.mjs) — Function for set webhook in dev
## Related templates
- [For Vercel Edge Functions](https://github.com/PonomareVlad/grammYVercelEdge)
- [For Vercel Edge Functions with streaming response](https://github.com/PonomareVlad/grammYVercelEdgeStream)
- [For Vercel Serverless Functions](https://github.com/PonomareVlad/grammYVercel)
Made with 💜 by [Vladislav Ponomarev](https://GitHub.com/PonomareVlad)