Bot starter template based on grammY bot framework.

• Scalable structure
• Config loading and validation
• Internationalization, language changing
• Graceful shutdown
• Logger (powered by pino)
• Fast and low overhead server (powered by fastify)
• Ready-to-use deployment setups:
  • Docker
  • Vercel
• Examples:
  • Prisma ORM

1. Create a new repository using this template.

2. Create an environment variables file:

cp .env.example .env

3. Set BOT_TOKEN environment variable in .env file.

4. Launch bot

   Development mode:

   # 1. Install dependencies
   npm i
   
   # 2. Run bot (in watch mode)
   npm run dev

   Production mode:

   # 1. Install dependencies
   npm i --only=prod
   
   # 2. Set NODE_ENV to production and change BOT_WEBHOOK to the actual URL to receive updates
   
   # 3. Run bot
   npm start 
   # or
   npm run start:force # if you want to skip type checking

• npm run lint — Lint source code.
• npm run format — Format source code.
• npm run typecheck — Runs type checking.
• npm run dev — Starts the bot in development mode.
• npm run start — Starts the bot.
• npm run start:force — Starts the bot without type checking.

Branch: deploy/docker-compose (open diff)

Use in your project:

1. Add the template repository as a remote

git remote add template [email protected]:bot-base/telegram-bot-template.git
git remote update

2. Merge deployment setup

git merge template/deploy/docker-compose -X theirs --no-commit --allow-unrelated-histories

Branch: deploy/vercel (open diff)

Use in your project:

1. Add the template repository as a remote

git remote add template [email protected]:bot-base/telegram-bot-template.git
git remote update

2. Merge deployment setup

git merge template/deploy/vercel -X theirs --no-commit --allow-unrelated-histories

Branch: example/prisma (open diff)

Use in your project:

1. Add the template repository as a remote

git remote add template [email protected]:bot-base/telegram-bot-template.git
git remote update

2. Merge example

git merge template/example/prisma -X theirs --no-commit --allow-unrelated-histories