https://github.com/nighty3098/techsupportbot
🌆 N9 GROUP technical support telegram bot
https://github.com/nighty3098/techsupportbot
aiogram aiogram-bot aiogrambot bot python3 sqlite sqlite-database sqlite3 sqlite3-database tech-support telegram-api telegram-bot telegram-channel
Last synced: 3 months ago
JSON representation
🌆 N9 GROUP technical support telegram bot
- Host: GitHub
- URL: https://github.com/nighty3098/techsupportbot
- Owner: Nighty3098
- License: mpl-2.0
- Created: 2024-07-02T15:35:28.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-03T09:27:14.000Z (7 months ago)
- Last Synced: 2025-04-04T17:02:33.109Z (6 months ago)
- Topics: aiogram, aiogram-bot, aiogrambot, bot, python3, sqlite, sqlite-database, sqlite3, sqlite3-database, tech-support, telegram-api, telegram-bot, telegram-channel
- Language: Python
- Homepage:
- Size: 8.75 MB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# TechSupportBot
**TechSupportBot** is a Telegram bot for user support, bug reporting, idea collection, and development order requests. The bot supports multiple languages and can work both in polling mode (locally) and via webhook (e.g., on Vercel).
## Features
- Accepts user requests (bug reports, feature suggestions, development orders)
- Supports attachments: text, photos, videos, documents
- Multilingual interface (Russian, English, Japanese, Spanish)
- Notifies a dedicated support chat about new tickets
- Ticket status system (new, in progress, completed, review)
- Users can change the interface language
## Quick Start
### 1. Clone the repository
```bash
git clone https://github.com/Nighty3098/TechSupportBot.git
cd TechSupportBot
```
### 2. Install dependencies
```bash
npm install
```
### 3. Configure environment variables
Create a `.env` file in the project root and specify:
```
BOT_TOKEN=your_bot_token
SUPPORT_CHAT_USERNAME=support_chat_or_user
NOTIFY_CHAT=chat_id_for_tickets
```
- `BOT_TOKEN` — your Telegram bot token
- `SUPPORT_CHAT_USERNAME` — username of the support chat/user for development orders
- `NOTIFY_CHAT` — chat ID (e.g., `-1001234567890`) where tickets will be sent
### 4. Run the bot locally
```bash
npm run dev
```
The bot will start in polling mode (for development).
### 5. Deploy to Vercel
- Use the function from `api/bot.ts` as the webhook endpoint.
- Set environment variables in your Vercel project settings.
- In Telegram, set the webhook to your Vercel endpoint URL.
## Project Structure
- `src/bot.ts` — main bot logic
- `src/locales/` — language files
- `api/bot.ts` — webhook endpoint (for Vercel)
- `src/local.ts` — polling mode launcher for local development
## Main Commands and Scenarios
- `/start` — greeting and main menu
- Menu buttons:
- Bug report
- Suggest an idea
- Order development
- Change language
The user selects a category, sends a message (and optionally attachments). The ticket is sent to the support chat with a status change button. When the status is changed, the user receives a notification.
## Localization
Supported languages:
- Russian
- English
- Japanese
- Spanish
## Dependencies
- [telegraf](https://github.com/telegraf/telegraf) — Telegram Bot API framework
- [dotenv](https://github.com/motdotla/dotenv) — environment variables
- [@vercel/node](https://vercel.com/docs/functions/serverless-functions/runtimes/node) — serverless functions for Vercel
- [typescript](https://www.typescriptlang.org/)
## Scripts
- `npm run build` — build TypeScript
- `npm run dev` — run in development mode (polling)
- `npm run start` — run (polling)
- `npm run local` — run (polling)
## License
ISC