Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/PonomareVlad/grammYVercelEdge
🤖 @grammyjs template for @Vercel Edge
https://github.com/PonomareVlad/grammYVercelEdge
edge edge-runtime grammy grammyjs javascript template vercel vercel-edge vercel-edge-functions
Last synced: 3 months ago
JSON representation
🤖 @grammyjs template for @Vercel Edge
- Host: GitHub
- URL: https://github.com/PonomareVlad/grammYVercelEdge
- Owner: PonomareVlad
- Created: 2023-04-13T10:24:31.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-17T17:36:50.000Z (8 months ago)
- Last Synced: 2024-07-15T10:48:44.919Z (4 months ago)
- Topics: edge, edge-runtime, grammy, grammyjs, javascript, template, vercel, vercel-edge, vercel-edge-functions
- Language: JavaScript
- Homepage: https://grammy.dev
- Size: 33.2 KB
- Stars: 9
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-grammY - PonomareVlad/grammYVercelEdge - Template for [Vercel Edge Functions](https://vercel.com/docs/concepts/functions/edge-functions). (Templates)
README
# Telegram Bot Template for [Vercel Edge Functions](https://vercel.com/docs/concepts/functions/edge-functions)
> 📖 [Documentation for grammY](https://grammy.dev)
## What does this template do for you
### 1. Instant prototyping
Just click the [blue button](#one-click-deploy) and change something in [src/bot.mjs](src/bot.mjs) in newly minted
repository
### 2. Universal bootstrap
Use [webhooks](https://grammy.dev/guide/deployment-types.html#how-do-webhooks-work)
or [long polling](https://grammy.dev/guide/deployment-types.html#how-does-long-polling-work) locally, even without a
Vercel project or [CLI](https://vercel.com/docs/cli)
### 3. Ready for production
Webhooks will be automatically installed for every deployment on Vercel during
the [build step](https://vercel.com/docs/concepts/deployments/builds)
## 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%2FgrammYVercelEdge&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&repository-name=grammy-vercel-edge)
### 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](#environment-variables) in the
> settings
##### Using long polling
```bash
npm run polling
```
##### Using webhooks 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 webhooks 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
## Environment variables
- `TELEGRAM_BOT_TOKEN` — Telegram bot token
from [@BotFather](https://core.telegram.org/bots/tutorial#obtain-your-bot-token)
- `TELEGRAM_SECRET_TOKEN` — [Secret token](https://core.telegram.org/bots/api#:~:text=secret_token) for incoming
requests
## Template structure
- [src/bot.mjs](src/bot.mjs) — Bot initialization and logic
- [scripts/start.mjs](scripts/start.mjs) — Starts bot in long polling mode
- [scripts/build.mjs](scripts/build.mjs) — Sets webhook URL at build step
- [api/webhook.mjs](api/webhook.mjs) — Function for set webhook URL at dev
- [api/update.mjs](api/update.mjs) — Function for receiving updates
## 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)