mirror of
https://github.com/hexastack/hexabot
synced 2024-11-24 13:05:15 +00:00
88 lines
4.6 KiB
Markdown
88 lines
4.6 KiB
Markdown
# Hexabot Live Chat Widget
|
||
The [Hexabot](https://hexabot.ai/) Live Chat Widget is a React-based embeddable widget that allows users to integrate real-time chat functionality into their websites. It connects to the Hexabot API and facilitates seamless interaction between end-users and chatbots across multiple channels.
|
||
|
||
## Key Features
|
||
- **Real-Time Chat:** Engage in real-time conversations with users directly through your website.
|
||
- **Customizable:** Easily customize the widget's appearance and behavior to fit your brand and website.
|
||
- **Multi-Channel Support:** Integrates with multiple messaging platforms through the Hexabot API.
|
||
- **Embeddable:** Simple to embed and integrate into any web page with just a few lines of code.
|
||
|
||
## Directory Structure
|
||
The Hexabot Live Chat Widget is organized into the following directory structure, under `src` we have:
|
||
|
||
- **src/assets:** Static assets like icons, fonts, and images used in the widget.
|
||
- **src/components:** Reusable React components that make up the chat widget interface, such as message bubbles, input fields, and buttons.
|
||
- **src/constants:** Hard coded values that are used like colors.
|
||
- **src/hooks:** Custom React hooks for managing widget state and handling side effects like API calls or real-time events.
|
||
- **src/services:** Handles external services, such as communication with the Hexabot API or other third-party integrations.
|
||
- **src/styles:** Contains the styling for the widget, including CSS or SCSS files used to define the look and feel of the chat interface.
|
||
- **src/providers:** Context providers for managing global state, such as user session, chat messages, and widget configurations.
|
||
- **src/translations:** Contains transalation of a couple of strings.
|
||
- **src/types:** Defines the typescript interfaces, types, and enums used.
|
||
- **src/utils:** Utility functions and helpers used throughout the widget, such as formatting, validations, or data transformations.
|
||
|
||
|
||
- **/public:** Contains static files that are publicly accessible. This includes the main HTML template where the widget is embedded for local development.
|
||
|
||
## Run the Live Chat Widget
|
||
|
||
### Dev Mode
|
||
To run the widget in development mode, execute the following command at the project root level:
|
||
```bash
|
||
npm run dev:widget
|
||
```
|
||
|
||
The live chat widget will be accessible at http://localhost:5173.
|
||
|
||
|
||
### Build for Production
|
||
To build the widget for production, execute the following command at the widget folder level:
|
||
```bash
|
||
npm run build
|
||
```
|
||
This will generate a production-ready build in the dist folder.
|
||
|
||
## Embed Chat Widget
|
||
Once the widget is built, you can easily embed it into any webpage. Here's an example of how to add it to your website:
|
||
|
||
|
||
```js
|
||
<script crossorigin src="https://unpkg.com/react@18/umd/react.production.min.js"></script>
|
||
<script crossorigin src="https://unpkg.com/react-dom@18/umd/react-dom.production.min.js"></script>
|
||
<link rel="stylesheet" href="./style.css">
|
||
<script src="<<WIDGET URL>>/hexabot-widget.umd.js"></script>
|
||
|
||
<div id="hb-chat-widget"></div>
|
||
<script>
|
||
const el = React.createElement;
|
||
const domContainer = document.getElementById('hb-chat-widget');
|
||
ReactDOM.render(
|
||
el(HexabotWidget, {
|
||
apiUrl: 'https://api.yourdomain.com',
|
||
channel: 'offline',
|
||
token: 'token123',
|
||
}),
|
||
domContainer,
|
||
);
|
||
</script>
|
||
```
|
||
Replace the values in apiUrl and token with your configuration details.
|
||
|
||
## Customization
|
||
You can customize the look and feel of the chat widget by modifying the widget’s scss styles or behavior. The widget allows you to:
|
||
|
||
- Change colors and fonts to match your website's branding.
|
||
- Configure user settings like language and chatbot response preferences.
|
||
|
||
## Contributing
|
||
We welcome contributions from the community! Whether you want to report a bug, suggest new features, or submit a pull request, your input is valuable to us.
|
||
|
||
Feel free to join us on [Discord](https://discord.gg/rNb9t2MFkG)
|
||
|
||
## License
|
||
This software is licensed under the GNU Affero General Public License v3.0 (AGPLv3) with the following additional terms:
|
||
|
||
1. The name "Hexabot" is a trademark of Hexastack. You may not use this name in derivative works without express written permission.
|
||
2. All derivative works must include clear attribution to the original creator and software, Hexastack and Hexabot, in a prominent location (e.g., in the software's "About" section, documentation, and README file).
|
||
3. SaaS Restriction: This software, or any derivative of it, may not be used to offer a competing product or service (SaaS) without prior written consent from Hexastack. Offering the software as a service or using it in a commercial cloud environment without express permission is strictly prohibited.
|