Merge pull request #21 from Satvik-Singh192/chatbot-feature

feat: add chatbot functionality with widget and api integration

Author: MD-IRFAN-RAJ

.gitignore

@@ -1 +1,2 @@
-node_modules
+node_modules
+.env

CHATBOT_README.md

@@ -0,0 +1,71 @@
+# 🤖 Chatbot Response Engine
+
+## How It Works
+
+The chatbot uses **OpenAI GPT-3.5-turbo** for intelligent responses to user queries. When OpenAI API is unavailable, it falls back to **predefined responses** for common questions.
+
+### Response Flow:
+1. User sends a message
+2. System categorizes the message (greeting, pricing, support, features)
+3. Analyzes sentiment (positive, negative, neutral)
+4. Calls OpenAI API if available, otherwise uses predefined responses
+5. Saves conversation to database
+6. Returns response to user
+
+### Message Categories:
+- **greeting**: hello, hi, hey
+- **pricing**: price, cost, pricing
+- **support**: help, support, issue, problem
+- **features**: feature, capability, what can
+- **default**: other queries
+
+### Predefined Responses:
+When OpenAI is unavailable, the chatbot uses simple predefined responses:
+```javascript
+greeting: "Hello! How can I help you today?"
+pricing: "Our pricing plans start at $9.99/month..."
+support: "I'm here to help! Can you describe the issue?"
+features: "Our platform offers mass email sending..."
+```
+
+## Setup
+
+1. Add OpenAI API key to `backend/.env`:
+```env
+OPENAI_API_KEY=your_openai_api_key_here
+```
+
+2. Install dependencies:
+```bash
+cd backend && npm install
+cd ../frontend && npm install
+```
+
+3. Start servers:
+```bash
+# Backend
+cd backend && npm run dev
+
+# Frontend  
+cd frontend && npm run dev
+```
+
+4. Visit `/chatbot` or use the chat widget
+
+## API Endpoints
+
+- `POST /api/chatbot/message` - Send message, get response
+- `GET /api/chatbot/history/:userId` - Get chat history
+- `POST /api/chatbot/test` - Test chatbot
+
+## Files Created
+
+**Backend:**
+- `services/chatbotService.js` - Core AI logic
+- `controllers/chatbotController.js` - API handlers
+- `routes/chatbotRoutes.js` - Routes
+- `models/Message.js` - Database schema
+
+**Frontend:**
+- `pages/Chatbot.jsx` - Chat interface
+- `components/ChatbotWidget.jsx` - Embeddable widget

README.md

@@ -143,12 +143,44 @@ Then simply run:
 
 npm start
 
-## 🤖 Planned Features
+## 🤖 AI Chatbot Feature (COMPLETED!)
+
+The AI Auto Responder chatbot has been successfully implemented! 🎉
+
+### What's Included:
+- **OpenAI Integration**: Uses GPT-3.5-turbo for intelligent responses
+- **Smart Fallback**: Predefined responses when OpenAI is unavailable
+- **Message Categorization**: Automatically categorizes queries (greeting, pricing, support, features)
+- **Sentiment Analysis**: Analyzes user message sentiment
+- **Full Chat Interface**: Complete chat page at `/chatbot`
+- **Embeddable Widget**: Chat widget for any page
+- **Conversation History**: Stores and retrieves chat history
+- **Analytics**: Usage analytics and insights
+
+### How to Use:
+1. **Set up OpenAI API key** in your `.env` file:
+   ```env
+   OPENAI_API_KEY=your_openai_api_key_here
+   ```
+
+2. **Access the chatbot**:
+   - Visit `/chatbot` for the full chat interface
+   - Use the chat widget on the home page
+   - Navigate via the "AI Assistant" link in the navbar
+
+3. **API Endpoints**:
+   - `POST /api/chatbot/message` - Send messages
+   - `GET /api/chatbot/history/:userId` - Get chat history
+   - `GET /api/chatbot/analytics/:userId` - Get analytics
+
+For detailed documentation, see [CHATBOT_README.md](./CHATBOT_README.md)
+
+## 🚀 Planned Features
 
 | Feature | Description | Status |
 |----------|-------------|--------|
 | 📧 Mass Email Sending | Send personalized bulk emails | ✅ Base setup |
-| 🧠 AI Auto Responder | AI chatbot replies to received emails | 🧩 Planned |
+| 🧠 AI Auto Responder | AI chatbot replies to received emails | ✅ **COMPLETED** |
 | 📅 Scheduler | Schedule campaigns for future dates | 🧩 Planned |
 | 📊 Dashboard | Track sent, opened, and clicked emails | 🧩 Planned |
 | 📂 Contact Management | Upload and manage email lists | 🧩 Planned |

backend/package.json

@@ -13,7 +13,10 @@
     "jsonwebtoken": "^9.0.2",
     "mongoose": "^6.9.1",
     "nodemailer": "^6.9.4",
-    "winston": "^3.8.2"
+    "winston": "^3.8.2",
+    "openai": "^4.20.1",
+    "dotenv": "^16.3.1",
+    "cors": "^2.8.5"
   },
   "devDependencies": {
     "nodemon": "^2.0.22"

backend/src/controllers/chatbotController.js

@@ -0,0 +1,73 @@
+const { askBot } = require('../services/chatbotService');
+const Message = require('../models/Message');
+const logger = require('../utils/logger');
+
+// Send message to chatbot and get response
+exports.sendMessage = async (req, res) => {
+  try {
+    const { message, userId } = req.body;
+    
+    if (!message || message.trim().length === 0) {
+      return res.status(400).json({
+        success: false,
+        error: 'Message is required and cannot be empty'
+      });
+    }
+
+    // Get chatbot response
+    const botResponse = await askBot(message, userId);
+    
+    res.status(200).json({
+      success: true,
+      data: {
+        message: message,
+        response: botResponse.reply,
+        category: botResponse.category,
+        sentiment: botResponse.sentiment,
+        timestamp: botResponse.timestamp
+      }
+    });
+
+  } catch (error) {
+    logger.error('Error in sendMessage controller:', error);
+    res.status(500).json({
+      success: false,
+      error: 'Internal server error. Please try again later.'
+    });
+  }
+};
+
+
+// Test chatbot endpoint (for development/testing)
+exports.testChatbot = async (req, res) => {
+  try {
+    const { message } = req.body;
+    
+    if (!message) {
+      return res.status(400).json({
+        success: false,
+        error: 'Test message is required'
+      });
+    }
+
+    const botResponse = await askBot(message);
+
+    res.status(200).json({
+      success: true,
+      data: {
+        input: message,
+        output: botResponse.reply,
+        category: botResponse.category,
+        sentiment: botResponse.sentiment,
+        timestamp: botResponse.timestamp
+      }
+    });
+
+  } catch (error) {
+    logger.error('Error in testChatbot controller:', error);
+    res.status(500).json({
+      success: false,
+      error: 'Chatbot test failed'
+    });
+  }
+};

backend/src/models/Message.js

@@ -0,0 +1,44 @@
+const mongoose = require('mongoose');
+
+const MessageSchema = new mongoose.Schema({
+  user: {
+    type: mongoose.Schema.Types.ObjectId,
+    ref: 'User',
+    required: true
+  },
+  message: {
+    type: String,
+    required: true,
+    trim: true
+  },
+  response: {
+    type: String,
+    required: true,
+    trim: true
+  },
+  timestamp: {
+    type: Date,
+    default: Date.now
+  },
+  category: {
+    type: String,
+    enum: ['general', 'support', 'sales', 'technical', 'other'],
+    default: 'general'
+  },
+  sentiment: {
+    type: String,
+    enum: ['positive', 'negative', 'neutral'],
+    default: 'neutral'
+  },
+  isAutoReply: {
+    type: Boolean,
+    default: true
+  }
+}, { timestamps: true });
+
+// Index for better query performance
+MessageSchema.index({ user: 1, timestamp: -1 });
+MessageSchema.index({ category: 1 });
+MessageSchema.index({ sentiment: 1 });
+
+module.exports = mongoose.model('Message', MessageSchema);

backend/src/routes/chatbotRoutes.js

@@ -0,0 +1,14 @@
+const express = require('express');
+const router = express.Router();
+const {
+  sendMessage,
+  testChatbot
+} = require('../controllers/chatbotController');
+
+// POST /api/chatbot/message - Send a message to the chatbot
+router.post('/message', sendMessage);
+
+// POST /api/chatbot/test - Test chatbot functionality (development endpoint)
+router.post('/test', testChatbot);
+
+module.exports = router;

backend/src/server.js

@@ -1,12 +1,17 @@
 require('dotenv').config();
 
 const express = require('express');
+const cors = require('cors');
 const connectDB = require('./config/db');
 const userRoutes = require('./routes/userRoutes');
+const chatbotRoutes = require('./routes/chatbotRoutes');
 
 const app = express();
+app.use(cors());
 app.use(express.json());
 
+app.use('/api/users', userRoutes);
+app.use('/api/chatbot', chatbotRoutes);
 app.use('/api/auth', userRoutes);
 
 const PORT = process.env.PORT || 5000;