https://github.com/simplisticated/reply-bot
Telegram bot for customer support and feedback management
https://github.com/simplisticated/reply-bot
Last synced: 11 months ago
JSON representation
Telegram bot for customer support and feedback management
- Host: GitHub
- URL: https://github.com/simplisticated/reply-bot
- Owner: simplisticated
- Created: 2025-03-29T14:56:16.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2025-04-19T15:58:11.000Z (11 months ago)
- Last Synced: 2025-04-19T19:17:19.031Z (11 months ago)
- Language: TypeScript
- Homepage:
- Size: 73.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# reply-bot
This bot acts as a bridge between users and administrators. It forwards messages
from users to administrators and allows administrators to reply directly to
those messages. When an administrator responds, the bot automatically sends the
reply back to the original user. Ideal for customer support or feedback
management in Telegram.
## Key Features
- Forwards user messages to administrators.
- Supports administrator replies, including text and photos.
- Automatically sends administrator responses back to the user.
## Implementation
Includes the following libraries and tools:
- TypeScript
- Telegraf.js
- Jest
- Prettier
- ESLint with Airbnb style
## How to Get Started
To begin, open your terminal and run the following command to install the
required dependencies:
```
npm install
```
For starting the server in development mode, use the following command:
```
npm run start:dev
```
To run the server in production mode, follow these steps:
```
npm run build
npm run start
```
## Environment Variables
This project relies on various environment variables for configuration. You can
set these variables either in a local `.env` file or through your hosting
environment, depending on your deployment method.
Here are the essential environment variables and their purposes:
- `TELEGRAM_TOKEN`: Defines the token that is used for Telegram bot.
- `ADMINISTRATOR_IDENTIFIERS`: An array of Telegram user identifiers that
receive forwarded messages from the bot and can respond to users.
You should create a `.env` file in the root of your project and define these
variables with their respective values.
Here is an example `.env` file:
```
TELEGRAM_TOKEN=1234567890
ADMINISTRATOR_IDENTIFIERS=1234567890,1234567890,1234567890,1234567890
```
## Scripts
The [package.json](./package.json) includes several useful scripts to manage,
build, and run the project efficiently. Below is a description of each script:
### Build and Run
- `build`
Deletes the existing `dist` folder and compiles TypeScript files based on the
`tsconfig.json` configuration.
```
npm run build
```
- `start`
Runs the compiled JavaScript app from the `dist` directory. This should be used
after running the `build` command.
```
npm run start
```
- `start:dev`
Runs the app in development mode using `ts-node` directly with the TypeScript
source files. Useful for quick development without building.
```
npm run start:dev
```
---
### Linting and Formatting
- `lint`
Runs ESLint and Prettier to check for code quality and formatting issues.
- `lint:fix`
Automatically fixes linting issues where possible.
```
npm run lint:fix
```
- `format`
Formats the code using Prettier.
```
npm run format
```
---
### Testing
- `test`
Runs tests using Jest.
```
npm run test
```
---
### Combined Checks
- `check`
Runs a series of checks, including building the project, running lint checks,
and executing tests.
```
npm run check
```
---
## Contributing
Your input is welcome! If you have any interesting ideas, suggestions, or would
like to contribute through pull requests, feel free to do so.