@zenesys/zene-chatbot
v0.1.5
Published
Universal Zene Chatbot - One package for all frameworks and platforms (React, Angular, Vue, Svelte, Vanilla JS, React Native)
Maintainers
Readme
Zene Chatbot
Universal chatbot solution for all frameworks and platforms - One package for all platforms!
📦 Published on npm: zene-chatbot
✨ Single Package Solution - No need to install separate packages! One
@zenesys/zene-chatbotpackage works for React, Angular, Vue, Svelte, Vanilla JS, and React Native.
📖 Documentation - Click to Read
All documentation is included in this package. Click any link below to open and read:
🚀 Getting Started Guides
| Document | Description | When to Use | |----------|-------------|-------------| | 📘 Configuration Guide ⭐ | Step-by-step configuration for all platforms | START HERE - First time setup | | ⚡ Quick Start Guide | Get started in 2 minutes | Need fast setup? | | 🚀 Implementation Guide | Detailed setup for all platforms | Need detailed instructions? |
📚 Reference Documentation
| Document | Description | When to Use | |----------|-------------|-------------| | 📖 Full Documentation | Complete API reference and advanced usage | Need API details? | | 🌐 Platform Support | Platform compatibility and requirements | Checking compatibility? | | 🏗️ Architecture | Technical architecture details | Understanding internals? | | 🔄 Migration Guide | Migrating from old versions | Upgrading from older version? |
📋 Quick Navigation
By Framework:
- 🌐 React / Next.js Setup | Detailed Guide
- 🔷 Angular Setup | Detailed Guide
- 💚 Vue 3 Setup | Detailed Guide
- 🟠 Svelte Setup | Detailed Guide
- 📜 Vanilla JS Setup | Detailed Guide
- 📱 React Native Setup | Detailed Guide
💡 New to Zene Chatbot? → Start with Configuration Guide ⭐
📋 Table of Contents
- 📖 Documentation - All documentation links
- 🌟 Features - Key features
- 📦 Installation - Install instructions
- 🚀 Quick Start Examples - Code examples for all frameworks
- 📚 Framework Support - Framework-specific guides
- 📦 Package Exports - Available imports
- 🔧 Configuration - Configuration options
- 💡 Getting Started - Step-by-step setup
- 🔗 Quick Links - All documentation links
🌟 Features
- ✅ Universal Support - React, Angular, Svelte, Vue, Vanilla JS, React Native, Flutter, Native Android/iOS
- ✅ Framework Agnostic Core - Business logic separated from UI
- ✅ TypeScript - Full type safety
- ✅ Voice Input/Output - Speech recognition and synthesis
- ✅ Streaming Responses - Real-time message streaming
- ✅ Dark Mode - Automatic theme detection
- ✅ Phone Validation - International phone number support
- ✅ Markdown Support - Rich text messages
📦 Installation
One package for all platforms! Install once, use everywhere:
npm install @zenesys/zene-chatbotThat's it! No additional packages needed. Use the same package for React, Angular, Vue, Svelte, Vanilla JS, and React Native.
📚 Need detailed instructions?
- Configuration Guide - Step-by-step setup for your framework
- Implementation Guide - Detailed setup for all platforms
- Quick Start Guide - Get started in 2 minutes
🚀 Quick Start Examples
React / Next.js
import { ZeneChatbot } from '@zenesys/zene-chatbot/react';
import '@zenesys/zene-chatbot/styles';
function App() {
return (
<ZeneChatbot
baseUrl="https://your-api-url.com"
bot_id="your_bot_id"
/>
);
}Angular
📖 Complete Angular Guide: See ANGULAR_GUIDE.md for detailed installation and usage instructions.
import { ZeneChatbotComponent } from '@zenesys/zene-chatbot/angular';
@Component({
template: `
<zene-chatbot
[baseUrl]="'https://your-api-url.com'"
[bot_id]="'your_bot_id'">
</zene-chatbot>
`
})
export class AppComponent {}Vue 3
<template>
<ZeneChatbot
baseUrl="https://your-api-url.com"
bot_id="your_bot_id"
/>
</template>
<script setup>
import { ZeneChatbot } from '@zenesys/zene-chatbot/vue';
</script>Svelte
<script>
import { ZeneChatbot } from '@zenesys/zene-chatbot/svelte';
</script>
<ZeneChatbot
baseUrl="https://your-api-url.com"
bot_id="your_bot_id"
/>Vanilla JavaScript
import { initZeneChatbot } from '@zenesys/zene-chatbot/vanilla';
initZeneChatbot({
baseUrl: 'https://your-api-url.com',
bot_id: 'your_bot_id',
containerId: 'chatbot-container'
});React Native
import { ZeneChatbot } from '@zenesys/zene-chatbot/react-native';
export default function App() {
return (
<ZeneChatbot
baseUrl="https://your-api-url.com"
bot_id="your_bot_id"
/>
);
}Core (Framework Agnostic)
import { ChatbotCore } from '@zenesys/zene-chatbot/core';
const chatbot = new ChatbotCore({
baseUrl: 'https://your-api-url.com',
bot_id: 'your_bot_id'
});
await chatbot.sendMessage('Hello!');📚 Framework Support
One package, all frameworks! Use zene-chatbot with any framework:
🌐 Web Frameworks
React / Next.js -
import { ZeneChatbot } from '@zenesys/zene-chatbot/react'Angular -
import { ZeneChatbotComponent } from '@zenesys/zene-chatbot/angular'Vue 3 -
import { ZeneChatbot } from '@zenesys/zene-chatbot/vue'Svelte -
import { ZeneChatbot } from '@zenesys/zene-chatbot/svelte'Vanilla JavaScript -
import { initZeneChatbot } from '@zenesys/zene-chatbot/vanilla'
📱 Mobile Frameworks
- React Native -
import { ZeneChatbot } from '@zenesys/zene-chatbot/react-native'
🔧 Core API
- Core (Framework Agnostic) -
import { ChatbotCore } from '@zenesys/zene-chatbot/core'
📦 Package Exports
One package, multiple entry points! Import from the specific framework path:
| Framework | Import Path | Example |
|-----------|-------------|---------|
| React | zene-chatbot/react | import { ZeneChatbot } from '@zenesys/zene-chatbot/react' |
| Angular | zene-chatbot/angular | import { ZeneChatbotComponent } from '@zenesys/zene-chatbot/angular' |
| Vue 3 | zene-chatbot/vue | import { ZeneChatbot } from '@zenesys/zene-chatbot/vue' |
| Svelte | zene-chatbot/svelte | import { ZeneChatbot } from '@zenesys/zene-chatbot/svelte' |
| Vanilla JS | zene-chatbot/vanilla | import { initZeneChatbot } from '@zenesys/zene-chatbot/vanilla' |
| React Native | zene-chatbot/react-native | import { ZeneChatbot } from '@zenesys/zene-chatbot/react-native' |
| Core API | zene-chatbot/core | import { ChatbotCore } from '@zenesys/zene-chatbot/core' |
| Styles | @zenesys/zene-chatbot/styles | import '@zenesys/zene-chatbot/styles' |
🔧 Configuration
Quick Configuration
| Prop | Type | Required | Description | Example |
|------|------|----------|-------------|---------|
| baseUrl | string | ✅ Yes | Your API base URL | "https://api.example.com" |
| bot_id | string | ✅ Yes | Your bot ID | "bot_9B3E7C348966" |
📖 Need detailed configuration instructions? See the Configuration Guide for step-by-step setup for your framework!
📖 Complete Documentation Index
All documentation files are included in this package. Click any link to read:
📘 Setup & Configuration
- Configuration Guide ⭐ - Step-by-step setup for all platforms (START HERE)
- Quick Start Guide - Get started in 2 minutes
- Implementation Guide - Detailed implementation for all platforms
📚 Reference & API
- Full Documentation - Complete API reference and advanced usage
- Platform Support - Platform compatibility matrix and requirements
- Architecture - Technical architecture and design details
🔄 Guides
- Migration Guide - Migrating from old versions
💡 Tip: All documentation files are in the package root. After installing, you can find them in node_modules/@zenesys/zene-chatbot/ or view them on npm.
🎯 Integration Guide by Platform
Web Frameworks
- React / Next.js - Most popular, full-featured
- Angular - Enterprise-ready, TypeScript-first
- Vue 3 - Progressive framework, easy to learn
- Svelte - Compile-time optimized
- Vanilla JavaScript - No framework required
Mobile Frameworks
- React Native - Cross-platform mobile apps
- Flutter - Dart-based mobile development
- Native Android - Kotlin/Java implementation
- Native iOS - Swift implementation
💡 Getting Started
📦 Install the package:
npm install @zenesys/zene-chatbot🔧 Follow the Configuration Guide:
- Choose your framework (React, Angular, Vue, Svelte, Vanilla JS, React Native)
- Copy the code example for your framework
- Replace
baseUrlandbot_idwith your values
✅ Test your chatbot:
- Run your application
- Send a test message
- Verify responses are received
📚 Explore advanced features:
- Check Full Documentation for all options
- See Implementation Guide for platform-specific details
That's it! 🎉 You're ready to use the chatbot!
📄 License
MIT
🔗 Quick Links
Essential Links
- 📦 npm Package: zene-chatbot
- ⭐ Configuration Guide: CONFIGURATION.md - Start here for setup
All Documentation (Click to Open)
- ⚡ Quick Start Guide - Get started in 2 minutes
- 🚀 Implementation Guide - Detailed platform guides
- 📖 Full Documentation - Complete API reference
- 🌐 Platform Support - Compatibility information
- 🏗️ Architecture - Technical details
- 🔄 Migration Guide - Upgrade instructions
📝 Note: All documentation files are included in the npm package. After installation, you can access them in
node_modules/@zenesys/zene-chatbot/or view online on npm.
Made with ❤️ - Universal chatbot for all platforms
