eShop - support bot

Microservice handles support via Telegram Bot

Table of Contents

• Introduction
• Features
• Requirements
• Quick Start
• Contributing

Introduction

The service allows receiving messages from users of the chatbot with inquiries and creating a "ticket" for the support. Support agents can receive feedback gathered for analytics.

Features

• Question Submission: Users can submit questions through the Telegram bot interface;
• Question Processing: Incoming questions stored in a database and processed by support group;
• Analytics: Optionally collects statistics like feedbacks for insights into user behavior;

Requirements

• Git
• Go >= 1.22
• Docker
• Postgres
• Redis
• Optional. Clickhouse

Quick start

1. Create bot using BotFather (video instruction). For example, eShopSupport;
2. Run application locally. Clone repository, modify environment and run it

git pull https://github.com/WildEgor/e-shop-support-bot &&
cd e-shop-support-bot &&
cp .env.example .env &&
go mod download &&
go run cmd/main.go

or using Docker

docker-compose up bot

Please, use this config if you want run Postgres, Redis and Clickhouse

1. Create Telegram group, add bot and make it admin. Next you can check saved group id using redis-cli

In a support group, you will receive "tickets" with user questions. Group users can "accept" or "reject" a ticket. If a ticket is "rejected," a new one can be created.

If the ticket is "accepted," users can discuss the issue through messages to the bot. Messages "duplicate" because I'm testing the functionality with the same account (pay attention to the sender of the message).

You can find "tickets" in the database table public.topics

Optional. If run this service you can find saved events in Clickhouse

Contributing

Please, use git cz for commit messages!

git clone https://github.com/WildEgor/e-shop-support-bot
cd e-shop-support-bot
git checkout -b feature-or-fix-branch
git add .
git cz
git push --set-upstream-to origin/feature-or-fix-branch

License

This project is licensed under the MIT License.

Made with ❤️ by me