Telebot 🎖️

Telebot is a telegram bot starter kit. Built on NodeJs and Telegraf Framework. This template allows you to build small simple bots to complex bots with ease. This template enables you to create small, simple bots, or complex bots with ease.

Features 👜

1. Ease of use: Telebot is built on top of Telegraf, a modern bot framework for Node.js. Telebot comes with the configuration you need to do for both development and production. Similar folder configuration to a typical Node.js & Express project.
2. Analytics and Logging: Telebot comes with LogSnag, a modern tracking tool for SASS that helps you track almost anything in your bot.
3. Easy deployment: Easily deploy your telegram bot like any other React, NextJs apps. Telebot comes with extra config to help you deploy your bot on Vercel
4. Service Architecture: Telebot comes with a service architecture that allows you to easily manage your bot services. Services like Databases, Email services, External API Integration and all can be easily integrated into your bot.

Get Started 🏃

1. Clone the repository

   git clone https://github.com/adedoyin-emmanuel/telebot

2. Install bot dependencies (You can use npm, yarn or bun)

   npm install

3. Get your bot token from BotFather https://telegram.me/BotFather.

4. Rename .env.example to .env

5. Copy your bot token to the BOT_TOKEN .env in the .env file.

6. Get your Logsnag API_KEY from https://app.logsnag.com

7. Paste your LogSnag API_KEY from https://app.logsnag.com to the LOGSNAG_TOKEN .env in the .env file.

8. Create a new project on Logsnag, copy the project name and then paste the project name in LOGSNAG_PROJECT env in the .env file.

9. Run the bot

   npm run dev

Contributing 🤝

First off, thanks for taking the time to contribute!

1. Star the repository, you can then create a fork
2. Clone your fork. Install the dependencies.
3. Create a branch for your feature (You can as well create an issue on that, so you can link it to your PR)
4. Commit your changes and push (Please give a descriptive message)
5. Submit your PR
6. Wait for your PR to be reviewed and merged

Acknowledgments 🫡

Telebot takes heavy inspiration from the following projects:

• telegram-bot-vercel-boilerplate (Mark Pavlov)
• telegram-bot-boilerplate (Yuri Nezdemkovski)

License 📯

Telebot is MIT-licensed open-source software by Adedoyin Emmanuel Adeniyi and contributors: