create telegram-bot-vercel-boilerplate

Author: sollidy

.env-sample

@@ -0,0 +1,5 @@
+BOT_TOKEN=""
+
+VERCEL_URL=""
+PORT=""
+NODE_ENV=""

.gitignore

@@ -0,0 +1,19 @@
+# dependencies
+/node_modules
+
+# testing
+/coverage
+
+# production
+/build
+/dist
+/public
+
+# misc
+.DS_Store
+.env*
+!.env-sample
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

.prettierrc

@@ -0,0 +1,6 @@
+{
+  "tabWidth": 2,
+  "useTabs": false,
+  "semi": true,
+  "singleQuote": true
+}

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Mark Pavlov https://github.com/m7mark.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,28 @@
+# Telegram Bot Vercel Boilerplate
+
+Telegram Bot Vercel Boilerplate based on Node.js and [Telegraf](https://github.com/telegraf/telegraf) framework.
+
+This template inspired by [Telegram Bot Boilerplate](https://github.com/yakovlevyuri/telegram-bot-boilerplate) for easily deploy to [Vercel](https://vercel.com).
+
+## Before you start
+
+First rename `.env-sample` file to `.env` and fill in all necessary values.
+
+```
+BOT_TOKEN="<YOUR_BOT_API_TOKEN>"
+```
+
+## Start your server
+
+```
+npm install
+npm dev
+```
+
+## Production
+
+You can fork this template and do the necessary changes you need. Then you when are done with your changes simply goto [vercel git import](https://vercel.com/import/git).
+
+## Demo
+
+You can see a working version of the bot at [@Node_api_m_bot](https://t.me/Node_api_m_bot)

api/index.ts

@@ -0,0 +1,13 @@
+import { VercelRequest, VercelResponse } from '@vercel/node';
+import { startVercel } from '../src';
+
+export default async function handle(req: VercelRequest, res: VercelResponse) {
+  try {
+    await startVercel(req, res);
+  } catch (e: any) {
+    res.statusCode = 500;
+    res.setHeader('Content-Type', 'text/html');
+    res.end('<h1>Server Error</h1><p>Sorry, there was a problem</p>');
+    console.error(e.message);
+  }
+}

package-lock.json

@@ -0,0 +1,30 @@
+{
+  "name": "telegram-bot-vercel-boilerplate",
+  "version": "1.1.0",
+  "description": "Telegram Bot Vercel Boilerplate",
+  "main": "src/index.ts",
+  "author": "Mark Pavlov (https://github.com/m7mark)",
+  "homepage": "https://github.com/m7mark/telegram-bot-vercel-boilerplate",
+  "dependencies": {
+    "@vercel/node": "^2.6.3",
+    "dotenv-cli": "^6.0.0",
+    "telegraf": "^4.10.0"
+  },
+  "devDependencies": {
+    "@types/debug": "^4.1.7",
+    "@types/node": "^18.11.9",
+    "@vercel/ncc": "^0.34.0",
+    "debug": "^4.3.4",
+    "nodemon": "^2.0.20",
+    "prettier": "^2.7.1",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.9.3"
+  },
+  "scripts": {
+    "dev": "DEBUG=bot* dotenv -- nodemon -e ts -x ts-node src/index.ts",
+    "devWindows": "@powershell -Command $env:DEBUG='bot*';dotenv -- -- nodemon -e ts -x ts-node src/index.ts",
+    "start": "NODE_ENV=production node public/index.js",
+    "build": "ncc build src/index.ts -o public -m",
+    "prettier": "prettier --write 'src/**/*.ts'"
+  }
+}

package.json

@@ -0,0 +1,14 @@
+import { Context } from 'telegraf';
+import createDebug from 'debug';
+
+import { author, name, version } from '../../package.json';
+
+const debug = createDebug('bot:about_command');
+
+const about = () => async (ctx: Context) => {
+  const message = `*${name} ${version}*\n${author}`;
+  debug(`Triggered "about" command with message \n${message}`);
+  await ctx.replyWithMarkdownV2(message, { parse_mode: 'Markdown' });
+};
+
+export { about };

src/commands/about.ts

@@ -0,0 +1 @@
+export * from './about';

src/commands/index.ts

@@ -0,0 +1,21 @@
+import { Context, Telegraf } from 'telegraf';
+import { Update } from 'telegraf/typings/core/types/typegram';
+import createDebug from 'debug';
+
+const debug = createDebug('bot:dev');
+
+const development = async (bot: Telegraf<Context<Update>>) => {
+  const botInfo = (await bot.telegram.getMe()).username;
+
+  debug('Bot runs in development mode');
+  debug(`${botInfo} deleting webhook`);
+  await bot.telegram.deleteWebhook();
+  debug(`${botInfo} starting polling`);
+
+  await bot.launch();
+
+  process.once('SIGINT', () => bot.stop('SIGINT'));
+  process.once('SIGTERM', () => bot.stop('SIGTERM'));
+};
+
+export { development };

src/core/development.ts

@@ -0,0 +1,2 @@
+export * from './development';
+export * from './production';

src/core/index.ts

@@ -0,0 +1,39 @@
+import { VercelRequest, VercelResponse } from '@vercel/node';
+import createDebug from 'debug';
+import { Context, Telegraf } from 'telegraf';
+import { Update } from 'telegraf/typings/core/types/typegram';
+import { BOT_TOKEN } from '..';
+
+const debug = createDebug('bot:dev');
+
+const PORT = (process.env.PORT && parseInt(process.env.PORT, 10)) || 3000;
+const VERCEL_URL = `${process.env.VERCEL_URL}/bot${BOT_TOKEN}`;
+
+const production = async (
+  req: VercelRequest,
+  res: VercelResponse,
+  bot: Telegraf<Context<Update>>
+) => {
+  debug('Bot runs in production mode');
+  debug(`setting webhook: ${VERCEL_URL}`);
+
+  if (!VERCEL_URL) {
+    throw new Error('VERCEL_URL is not set.');
+  }
+
+  const getWebhookInfo = await bot.telegram.getWebhookInfo();
+  if (getWebhookInfo.url !== VERCEL_URL + '/api') {
+    debug(`deleting webhook ${VERCEL_URL}`);
+    await bot.telegram.deleteWebhook();
+    debug(`setting webhook: ${VERCEL_URL}/api`);
+    await bot.telegram.setWebhook(`${VERCEL_URL}/api`);
+  }
+
+  if (req.method === 'POST') {
+    await bot.handleUpdate(req.body as unknown as Update, res);
+  } else {
+    res.status(200).json('Listening to bot events...');
+  }
+  debug(`starting webhook on port: ${PORT}`);
+};
+export { production };

src/core/production.ts

@@ -0,0 +1,21 @@
+import { Telegraf } from 'telegraf';
+
+import { about } from './commands';
+import { greeting } from './text';
+import { VercelRequest, VercelResponse } from '@vercel/node';
+import { development, production } from './core';
+
+export const BOT_TOKEN = process.env.BOT_TOKEN || '';
+const ENVIRONMENT = process.env.NODE_ENV || '';
+
+const bot = new Telegraf(BOT_TOKEN);
+
+bot.command('about', about());
+bot.on('text', greeting());
+
+//prod mode (Vercel)
+export const startVercel = async (req: VercelRequest, res: VercelResponse) => {
+  await production(req, res, bot);
+};
+//dev mode
+ENVIRONMENT !== 'production' && development(bot);

src/index.ts

@@ -0,0 +1,22 @@
+import { Context } from 'telegraf';
+import createDebug from 'debug';
+
+const debug = createDebug('bot:greeting_text');
+
+const replyToMessage = (ctx: Context, messageId: number, string: string) =>
+  ctx.reply(string, {
+    reply_to_message_id: messageId,
+  });
+
+const greeting = () => async (ctx: Context) => {
+  debug('Triggered "greeting" text command');
+
+  const messageId = ctx.message?.message_id;
+  const userName = `${ctx.message?.from.first_name} ${ctx.message?.from.last_name}`;
+
+  if (messageId) {
+    await replyToMessage(ctx, messageId, `Hello, ${userName}!`);
+  }
+};
+
+export { greeting };

src/text/greeting.ts

@@ -0,0 +1 @@
+export * from './greeting';

src/text/index.ts

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "strict": true,
+    "target": "esnext",
+    "moduleResolution": "node",
+    "module": "commonjs",
+    "skipLibCheck": true,
+    "sourceMap": true,
+    "outDir": "public",
+    "lib": ["esnext", "dom"],
+    "resolveJsonModule": true
+  },
+  "exclude": ["node_modules"]
+}

tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "version": 2,
+  "public": true,
+  "rewrites": [
+    {
+      "source": "/(.*)",
+      "destination": "api/index.ts"
+    }
+  ],
+  "redirects": [{ "source": "/", "destination": "/api", "permanent": false }]
+}