https://github.com/daley-mottley/customer-support-bot
Customer Support Bot is a WordPress plugin that enables businesses to automate customer support using AI technology. #hacktoberfest
https://github.com/daley-mottley/customer-support-bot
ai chatbot chatgpt hacktoberfest open-source wordpress wordpress-plugin
Last synced: over 1 year ago
JSON representation
Customer Support Bot is a WordPress plugin that enables businesses to automate customer support using AI technology. #hacktoberfest
- Host: GitHub
- URL: https://github.com/daley-mottley/customer-support-bot
- Owner: daley-mottley
- License: mit
- Created: 2024-09-08T18:32:32.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-30T00:35:20.000Z (over 1 year ago)
- Last Synced: 2025-04-16T09:22:50.308Z (over 1 year ago)
- Topics: ai, chatbot, chatgpt, hacktoberfest, open-source, wordpress, wordpress-plugin
- Language: PHP
- Homepage: https://tinyurl.com/customer-support-chatbot
- Size: 511 KB
- Stars: 12
- Watchers: 1
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
☀️ Customer Support Bot ☀️
Request Feature
·
View Demo
·
Report Bug
Contributing Guidelines & Code of Conduct
[](https://github.com/ellerbrock/open-source-badges/)
## Project Overview 📑
**Customer Support Bot** is a WordPress plugin that enables businesses to automate customer support using AI technology, now powered by the **Google Gemini API**. The bot offers features like knowledge base searches (basic conversational ability), appointment scheduling checks, and appointment booking capabilities to enhance user experience and reduce the workload on customer support agents.
## Table of Contents📋
- [Features](#features-)
- [Technologies Used](#technologies-used-)
- [Installation](#installation-️)
- [Download from GitHub](#1-download-from-github)
- [Clone the Repository](#2-clone-the-repository)
- [Configuration](#configuration-)
- [Help Wanted](#help-wanted-)
- [Report A Bug](#report-a-bug-)
- [Contributions](#contributions)
- [Contributors](#contributors)
- [Let's Stay Connected](#lets-stay-connected)
## Features 📝
- 📌 Conversational AI: Engage users with responses powered by Google Gemini.
- 📌 Appointment Availability Checks: Check appointment slots via webhook integration.
- 📌 Appointment Scheduling: Allow users to book appointments through the bot via webhook integration.
- 📌 Customization Settings: Customize bot appearance (colors), avatar, name, and greeting in the WordPress admin panel.
## Technologies Used 📚
- [WordPress](https://wordpress.org/) – CMS platform where the plugin is installed and activated.
- [PHP](https://www.php.net/) – Server-side language for API interactions and WordPress plugin development.
- [JavaScript](https://developer.mozilla.org/en-US/docs/Web/JavaScript) – Frontend logic for chatbot interaction.
- [Axios](https://axios-http.com/docs/intro) – HTTP client used on the frontend for AJAX requests.
- [Bootstrap](https://getbootstrap.com/) – CSS framework for styling the admin settings page.
- [Google Gemini API](https://ai.google.dev/) – Integrates AI capabilities for advanced NLP features and function calling.
## Installation ⚙️
You can install the **Customer Support Bot** plugin in two ways:
### 1. Download from GitHub
- Go to the [GitHub repository](https://github.com/daley-mottley/customer-support-bot) and download the repository as a ZIP file (e.g., from the "Code" button -> "Download ZIP").
- Navigate to your WordPress admin dashboard.
- Go to **Plugins > Add New > Upload Plugin**.
- Choose the downloaded ZIP file and click **Install Now**.
- After installation, click **Activate Plugin**.
### 2. Clone the Repository
Alternatively, you can clone the repository using Git if you have command-line access to your server:
1. Navigate to your WordPress plugin directory (usually located at `wp-content/plugins/`).
2. Clone the repository: `git clone https://github.com/daley-mottley/customer-support-bot.git`
3. Log in to your WordPress admin dashboard.
4. Go to **Plugins > Installed Plugins**.
5. Find **Customer Support Bot** in the list and click **Activate**.
## Configuration ⚙️
After activating the plugin, navigate to **Settings -> Chat Widget** in your WordPress admin dashboard. You **must** configure the following for the bot to work:
- **Gemini API Key:** Enter your API key obtained from [Google AI Studio](https://aistudio.google.com/app/apikey). This is required.
- **Assistant Name:** Customize the name displayed in the chat header (e.g., "Support Bot", "Booking Assistant").
- **Avatar Image:** Upload a custom avatar image for the bot.
- **Bot Greeting:** Set the initial message the bot displays when opened by a user.
- **Theme & Text Colors:** Customize the primary background color and text color of the chat widget.
- **Webhook URLs:** If you want to use appointment checking or booking, enter the full webhook URLs provided by your automation service (like Make.com or Zapier) for the "Check Availability" and "Book Appointment" functions.
**Save your settings** after making changes.
## Help Wanted 🪧
We are looking for contributors to help add more features! Some ideas include:
- [ ] **Conversation History:** Implement frontend and backend logic to remember the context of the current chat session.
- [ ] **Knowledge Base Integration:** Allow the bot to search WordPress posts/pages or a custom knowledge base to answer questions.
- [ ] **Basic Troubleshooting**: Provide users with automated solutions for common problems based on predefined flows.
- [ ] **Ticket Categorization**: Automatically sort incoming support tickets (if integrated with a helpdesk).
- [ ] **Status Updates**: Notify users of ticket status and resolution progress (if integrated).
- [ ] **Password Resets**: Allow users to initiate password resets through the bot (requires integration).
- [ ] **Billing Inquiries**: Help users resolve common billing-related questions.
- [ ] **Product Information**: Provide detailed information on products/services.
- [ ] **Return/Refund Processing**: Guide users through the process of returns or refunds (requires integration).
- [ ] **Escalation Management**: Option to escalate unresolved issues to human support agents (e.g., via email or helpdesk ticket).
- [ ] **Satisfaction Surveys**: Gather feedback from users about their support experience.
- [ ] **Multi-language Support**: Offer support in multiple languages.
## Report A Bug 🪰
If you encounter any issues or have questions, feel free to [open an issue](https://github.com/daley-mottley/customer-support-bot/issues/new?assignees=&labels=bug&projects=&template=bug_report.yml&title=%5BBug%5D+) or reach out to the maintainers. Please provide as much detail as possible, including steps to reproduce the bug.
Contributions are welcome! It only takes five (5) steps!
To contribute:
1) Fork the repository.
2) Create a new branch for your feature or bug fix: `git checkout -b my-feature-branch`.
3) Make your changes and commit them with clear messages: `git commit -m 'Add some feature'`.
4) Push your changes to your forked repository: `git push origin my-feature-branch`.
5) Open a pull request against the `main` branch of the original repository.
Please read our Contributing Guidelines to get started! 🚀
Say 'Hi' To Our Contributors!
🫶 Thank you for your support! 🙌
🌎 Let's Stay Connected!🫸🫷
If you like this project and would like to see more features or show your support.
Feel free to reach out to the developers and give this project a ⭐!