https://github.com/adedoyin-emmanuel/telebot
A telegram bot starterkit with realtime analytics. Built on Telegraf.
https://github.com/adedoyin-emmanuel/telebot
bot open-source starter-kit starter-template telegraf telegraf-bot telegram-bot
Last synced: 9 months ago
JSON representation
A telegram bot starterkit with realtime analytics. Built on Telegraf.
- Host: GitHub
- URL: https://github.com/adedoyin-emmanuel/telebot
- Owner: Adedoyin-Emmanuel
- License: mit
- Created: 2024-07-11T13:21:54.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-06T23:22:15.000Z (almost 2 years ago)
- Last Synced: 2025-03-26T00:41:23.564Z (about 1 year ago)
- Topics: bot, open-source, starter-kit, starter-template, telegraf, telegraf-bot, telegram-bot
- Language: TypeScript
- Homepage: https://t.me/usetelebot
- Size: 195 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Telebot 🎖️
Telebot is a telegram bot starter kit. Built on [NodeJs](https://nodejs.org) and [Telegraf](https://telegraf.js.org) 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](https://vercel.com)
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
```bash
git clone https://github.com/adedoyin-emmanuel/telebot
```
2. Install bot dependencies (You can use npm, yarn or bun)
```bash
npm install
```
3. Get your bot token from **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
7. Paste your LogSnag **API_KEY** from 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
```bash
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`](https://github.com/sollidy/telegram-bot-vercel-boilerplate) ([Mark Pavlov](https://github.com/sollidy))
- [`telegram-bot-boilerplate`](https://github.com/nezdemkovski/telegram-bot-boilerplate) ([Yuri Nezdemkovski](https://github.com/nezdemkovski))
## License 📯
Telebot is [MIT-licensed](LICENSE) open-source software by [Adedoyin Emmanuel Adeniyi](https://github.com/adedoyin-emmanuel) and [contributors](https://github.com/adedoyin-emmanuel/telebot/graphs/contributors):
