This Rocket.Chat app provides an AI Assistant bot to help you understand the Rocket.Chat codebase. Built on top of Rocket.Chat's app framework, the bot leverages open-source LLMs (Large Language Models) from Hugging Face Inference APIs to answer your queries about the code's structure, logic, and workflows directly into the room
-
Installation:
- Install the app on your Rocket.Chat server.
-
Usage:
- Navigate to the dedicated AI Assistant room.
- Ask any questions you have regarding the Rocket.Chat codebase.
- The bot will promptly respond with relevant information.
-
Customization:
- Modify app settings to change the language model (LLM) or view available LLMs.
- Use commands provided within the app to customize settings.
To set up the AI Assistant bot locally, follow these steps:
-
Prerequisites:
-
Clone the Repository:
git clone https://github.com/<github_handle>/ai-assistant-bot.git
-
Install Dependencies::
npm install
-
Deploy your app locally::
rc-apps deploy --url http://localhost:3000 --username ${username} --password ${password}
Your username and password are your local server's user credentials .Verify the successful build by accessing the /excalidraw endpoint in the Whiteboard app settings. You can access the React app through the provided URL.