README

Axora

Axora delivers transient, named JSON events to Laravel browser sessions over Server-Sent Events. Its standalone asynchronous daemon holds browser connections without occupying PHP-FPM workers and briefly buffers events that arrive just before a session connects.

Requirements

PHP 8.5 or later
Laravel 13
Redis
A same-origin reverse proxy and process supervisor in production

Installation

composer require artisan-toolbox/axora

{
    "dependencies": {
        "@artisan-toolbox/axora": "file:vendor/artisan-toolbox/axora"
    }
}

Start the standalone server:

php artisan axora:start

Minimal usage

Send an event to the current Laravel session:

axora()->send('toast', [
    'type' => 'success',
    'message' => 'Saved.',
]);

Initialize one browser connection and subscribe to the event:

import { axora, initializeAxora } from "@artisan-toolbox/axora";

axora.on("toast", ({ type, message }) => {
    showToast(type, message);
});

initializeAxora();

The complete setup, TypeScript event map, Vue composable, queued user delivery, configuration, deployment, and troubleshooting guides are available in the Axora documentation.

Stability

Axora is pre-release software. Backward compatibility is not guaranteed until 1.0.

artisan-toolbox / axora

Maintainers

Package info

Fund package maintenance!

Statistics

Security