portfolio-chatbot-ray
v1.1.3
Published
AI chatbot for portfolios - add Groq-powered conversational AI to any portfolio in minutes
Maintainers
Readme
Portfolio Chatbot Ray
An intelligent, easily customizable AI-powered chatbot component designed specifically for developer portfolios. Add a Groq-powered conversational virtual assistant to any portfolio website in minutes!
✨ Features
- Zero Configuration RAG: Automatically fetches your portfolio data (projects, skills, experiences, social profiles) and uses Retrieval-Augmented Generation to answer user questions contextually.
- Smart UI/UX: Includes a sleek
FloatingChatbotthat can be positioned on the bottom-right or bottom-left of your screen. - Fully Customizable: Control colors, themes (Dark, Light, Minimal, Orange), button placements, and welcome messages via a visual builder.
- Responsive: Scales perfectly on both desktop and mobile devices.
- Secure: Filters profanity and safely parses markdown links for your social profiles.
📦 Installation
npm install portfolio-chatbot-ray🚀 Quickstart
import { FloatingChatbot } from 'portfolio-chatbot-ray';
import 'portfolio-chatbot-ray/style.css'; // Important for Tailwind styles!
function App() {
return (
<div>
<h1>My Awesome Portfolio</h1>
{/* Renders a beautiful floating chat bubble */}
<FloatingChatbot
portfolioId="your-unique-portfolio-id"
apiKey="your-groq-api-key"
/>
</div>
);
}⚙️ Props
| Prop | Type | Required | Description |
|------|------|----------|-------------|
| portfolioId | string | ✅ | Your unique portfolio ID from the visual builder dashboard. |
| apiKey | string | ✅ | Your Groq API key for the AI chat model. |
| apiBaseUrl | string | ❌ | Override the default API server URL. |
| customTheme | object | ❌ | Override default theme colors. |
🛠️ How It Works
- Configure: Create and customize your chatbot knowledge base on the visual dashboard.
- Copy ID: Copy your unique
portfolioId. - Embed: Install this package, pass the ID, and the chatbot fetches your config and acts as your personalized virtual assistant instantly!
📄 License
This project is licensed under the MIT License - see the LICENSE file for details.
