Skip to content

Home

Jump to bottom
Rathod Ritesh M edited this page Sep 16, 2025 · 2 revisions

Welcome to the WP Live Chat Users Wiki! 👋

License: GPL-2.0+ WordPress PHP Node.js Socket.IO

Welcome to the comprehensive documentation for WP Live Chat Users - a modern, real-time chat system for WordPress that enables seamless user-to-user communication with a self-hosted WebSocket server.

🚀 What is WP Live Chat Users?

WP Live Chat Users is a complete real-time chat solution that transforms your WordPress site into a dynamic communication platform. Built with modern technologies including React, TypeScript, and Socket.IO, it provides:

  • Real-time messaging with instant delivery
  • Live typing indicators and presence status
  • Message read receipts and delivery confirmations
  • File attachments and rich media support
  • Thread-based conversations with persistent history
  • Self-hosted WebSocket server for complete control

📚 Documentation Structure

This wiki is organized into the following sections to help you get started quickly and master the platform:

🏁 Getting Started

🏗️ Development

🔧 Administration

🚀 Deployment

🛠️ Customization

🎯 Quick Navigation

I want to... Go to
Get started immediately Quick Start Guide
Install from scratch Installation Instructions
Understand the architecture Architecture Overview
Use the REST API API Documentation
Customize the interface Theme Integration
Deploy to production Production Deployment
Troubleshoot issues Troubleshooting
Contribute to development Contributing Guidelines

🌟 Key Features Highlights

💬 Real-Time Communication

  • Instant message delivery with WebSocket technology
  • Live typing indicators and user presence
  • Connection status monitoring and automatic reconnection
  • Cross-tab synchronization for seamless experience

🔐 Security & Authentication

  • WordPress user authentication integration
  • API key authentication for external access
  • Permission-based access control
  • Input sanitization and validation

📱 Modern Interface

  • Responsive design for all devices
  • Dark/light theme support
  • Accessibility (WCAG 2.1 AA compliant)
  • Smooth animations and transitions

⚡ Performance Optimized

  • Lazy loading for large conversation histories
  • Optimistic UI updates for instant feedback
  • Database query optimization
  • Efficient WebSocket connection management

🏆 System Architecture

graph TB
    A[WordPress Frontend] --> B[React Chat Component]
    B --> C[Socket.IO Client]
    C --> D[Socket.IO Server]
    D --> E[WordPress REST API]
    E --> F[WordPress Database]
    
    G[WordPress Admin] --> H[Plugin Configuration]
    H --> I[API Settings]
    I --> J[Database Migrations]
    
    K[User Authentication] --> L[WordPress Session]
    K --> M[API Key Authentication]
Loading

📋 Quick Installation Checklist

  • WordPress 5.6+ with PHP 7.4+
  • Node.js 16+ installed on server
  • Upload and activate the WordPress plugin
  • Run database migrations: wp wplc migrate
  • Configure Socket.IO server settings
  • Start the WebSocket server: npm start
  • Add [wpcl-chat] shortcode to desired pages
  • Test real-time messaging functionality

🤝 Getting Help

📖 Documentation

  • Browse the wiki sections listed above
  • Check the Troubleshooting guide for common issues
  • Review the FAQ for frequently asked questions

💬 Community Support

  • GitHub Discussions - Ask questions and share ideas
  • GitHub Issues - Report bugs and request features
  • Contributing Guidelines - Help improve the project

🐛 Reporting Issues

When reporting issues, please include:

  • WordPress version and active plugins
  • PHP version and server environment
  • Node.js version and operating system
  • Detailed steps to reproduce the issue
  • Error messages from browser console and server logs

🎉 What's New

Latest Release Features

  • ✅ API Authentication System - Secure Socket.IO server integration
  • ✅ Real-time Thread Management - Dynamic conversation creation
  • ✅ Enhanced Frontend - React-based modern interface
  • ✅ Database Migrations - Automated setup and updates
  • ✅ Admin Interface - Complete WordPress admin integration

Coming Soon

  • 🔄 Group Chat Support - Multi-user conversations
  • 📎 Rich Media Attachments - Images, documents, and files
  • 🔔 Push Notifications - Browser and mobile notifications
  • 📊 Analytics Dashboard - Usage statistics and insights
  • 🌐 Multi-language Support - Internationalization (i18n)

📝 Contributing

We welcome contributions from the community! Whether you're:

  • 🐛 Reporting bugs or suggesting features
  • 📝 Improving documentation or writing tutorials
  • 💻 Contributing code or fixing issues
  • 🎨 Designing interfaces or creating themes

Check out our Contributing Guidelines to get started.

📄 License

This project is licensed under the GPL-2.0+ license, the same license used by WordPress itself.

📚 Wiki Navigation

Quick Links

Resources

🤝 Community & Support

Resource Description Link
💬 Discord Community Join our Discord server for real-time chat 🎮 Join Discord
📖 Documentation Complete project documentation 📚 GitHub Wiki
🐛 Bug Reports Report issues and bugs 🔧 GitHub Issues
💡 Feature Requests Suggest new features 💭 GitHub Discussions
📧 Direct Contact Reach the maintainer 👨‍💻 @Ri2rathod

🎯 Get Help Fast

⭐ Project Info

WP Live Chat Users - Real-time WordPress chat system with Socket.IO

Join our community: 💬 Discord • 💭 Discussions • 🐛 Issues

Found this helpful? ⭐ Star the repo • 🔀 Share with others • 🤝 Contribute to the project

Last updated: September 2025 • Page maintained by the WP Live Chat Users community

Clone this wiki locally