README — uzapoint/realtime-core

Repository:
https://github.com/uzapoint/realtime-core

---

# Uzapoint Realtime Core

Lightweight real-time broadcasting infrastructure for Laravel microservices.

Uses Redis Pub/Sub to communicate with WebSocket servers.

Designed to integrate seamlessly with Uzapoint EventBus Core.

---

## Features

- Redis-based broadcasting
- Microservice-safe channel namespacing
- Minimal dependencies
- Compatible with Laravel Echo
- Production-ready logging
- Failure-safe publishing

---

## Installation

```bash
composer require uzapoint/realtime-core

---

Broadcasting Events

use Uzapoint\Realtime\WebSocketBroadcaster;

$broadcaster->broadcast(
    eventName: 'tenant.registration.completed',
    data: [
        'auth_user_id' => 12,
        'status' => 'success',
    ],
    channel: 'job.1234'
);

Published to Redis channel:

laravel_database_job.1234

---

Expected WebSocket Setup

Your WebSocket server should:

• Listen to Redis channels
• Forward payloads to connected clients
• Support channel-based subscription

Example payload:

{
  "event": "tenant.registration.completed",
  "data": {
    "auth_user_id": 12,
    "status": "success"
  }
}

---

Architecture Philosophy

Simple. Focused. Infrastructure-only.

No opinion about:

• Frontend framework
• WebSocket server implementation
• Channel naming convention

Only provides:

• Safe publishing
• Structured payload
• Logging

---

License

MIT

---

Author

Sammy Orondo Lead Developer — Uzapoint https://github.com/sammy-boy