grammY Vercel boilerplate

grammY boilerplate to develop and host telegram bots on Vercel.

Features

• Typescript support
• Linting and formatting preconfigured
• Development friendly environment with Nodemon

Development

# Copy the .env example and change the BOT_TOKEN to match yours
$ cp .env.example .env
# Install the dependencies
$ npm install
# Run the development environment
$ npm run dev

Deployment

Terminal

# Install vercel cli if you don't have it yet
$ npm i -g vercel
# Deploy the project
$ vercel --prod

Vercel

On your project's page, go to Settings > Environment Variables and add the following variables:

Name	Value
BOT_TOKEN	your bot token

You can also set the webhook URL manually accessing https://api.telegram.org/bot<bot_token>/setWebhook?url=<webhook_url> on your browser

Finally, you should see a "Hello, world!" from the bot when typing /hello in chat.

Using Express instead of Vercel's API

By default grammy-vercel-boilerplate does not use extra dependencies, but in case you want to use Express, first add it as a dependency

$ npm install express

And then edit the contents of api/index.ts to

require("../src/index");

import express from "express";
import { webhookCallback } from "grammy";

import bot from "../src/core/bot";

const app = express();

app.use(express.json());
app.use(`/api/index`, webhookCallback(bot));

export default app;

Contributing

Pull requests are welcome. If you have any suggestions, you can also create an issue.

License

MIT