Skip to content

Latest commit

 

History

History
126 lines (93 loc) · 4.97 KB

README.md

File metadata and controls

126 lines (93 loc) · 4.97 KB

Quick Replies with Rocket.Chat


Quick Replies Feature for RocketChat

View Demo · Report Bug · Request Feature

Contributors Forks Stargazers Issues MIT License

📜 Getting Started

Prerequisites

  • You need a Rocket.Chat Server Setup
  • Rocket.Chat.Apps CLI,
  • In case you don't have run:
    npm install -g @rocket.chat/apps-cli

⚙️ Installation

  • Every RocketChat Apps runs on RocketChat Server, thus everytime you wanna test you need to deploy the app with this note. lets start setting up:
  1. Clone the repo

    git clone https://github.com/<yourusername>/Apps.QuickReplies
  2. Install NPM packages

    npm ci
  3. Deploy app using:

    rc-apps deploy --url <url> --username <username> --password <password>

✅ About The Project:


The project aims to enhance customer support efficiency by introducing a Quick Replies feature in the helpdesk system.
This will allow agents/user to create, save, and use predefined responses to common queries, accessible via a button or keyboard shortcut.
By selecting quick replies instead of typing manually, agents/users can respond faster and maintain consistent communication, improving productivity and customer satisfaction.

🚀 Usage :

👋 Need some help with /quick or /qs?

  • /quick: Get started with Quick Reply
  • /quick create: Create a new quick reply
  • /quick list: List all your quick replies
  • /quick config: Configure your language preferences and AI settings
  • /quick ai: Use AI to generate replies
  • /quick help: Get help with Quick Reply
  • /qs <reply name>: Quickly search and send a reply by name

Using Placeholders:

When creating or configuring a reply, you can use placeholders like [name], [username], and [email] in the reply content. These placeholders will automatically be replaced based on the recipient's information when the message is sent.

🧑‍💻 Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue. Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feat/AmazingFeature)
  3. Commit your Changes (git commit -m 'feat: adds some amazing feature')
  4. Push to the Branch (git push origin feat/AmazingFeature)
  5. Open a Pull Request

📚 Resources

Here are some links to examples and documentation: