/chatiq-bot-applet

JS Widget that plugins into your website, and gives you a webhook to send and get response from an external API.

Primary LanguageHTML

Pyaw - Chat Assistant Plugin

Description

Pyaw - Chat Assistant Plugin is a customer-facing chatbot/chat assistant interface designed to connect with the Pyaw application using bot ID, domain, and WebSocket URLs. It integrates seamlessly into any site using an iframe. Internally, it utilizes TailwindCSS, DaisyUI, and Alpine.js for styling and functionality.

Local Testing

To test Pyaw - Chat Assistant Plugin locally, follow the structure outlined below:

File Structure

  1. local-test.html

    • This file serves as the main entry point for local testing.
    • It includes references to two essential files: styles.css and script.js.

  2. styles.css

    • Contains the styling rules and some custom CSS to enhance the appearance of the chatbot.

  3. script.js

    • The core logic of the chatbot is implemented here, handling the chat interactions and connecting to the Pyaw application.

Steps to Test Locally

  1. Download the Repository

    • Clone the repository to your local machine using the following command: 
      git clone https://github.com/your-repo/Pyaw - Chat Assistant Plugin.git

  2. Navigate to the Project Directory

    • Change into the project directory: 
      cd Pyaw - Chat Assistant Plugin

  3. Open local-test.html

    • Open the local-test.html file in your preferred web browser to test the chatbot interface.

Contributing

If you encounter any issues or have feature requests, please feel free to raise an issue or submit a pull request (PR) on the [GitHub repository](https://github.com/your-repo/Pyaw - Chat Assistant Plugin/issues).

Useful Links

  • TailwindCSS: A utility-first CSS framework for rapidly building custom user interfaces.
  • DaisyUI: A component library for TailwindCSS.
  • Alpine.js: A rugged, minimal framework for composing JavaScript behavior in your HTML.

For a deeper understanding of the concepts used in this project, you can refer to the following:

  • WebSocket: A protocol for creating real-time interactive applications.
  • iframe: An HTML element that embeds another HTML page within the current page.

By following these guidelines, you can ensure a professional and detailed documentation for the Pyaw - Chat Assistant Plugin.