Quick Start

Get Nexo running in under 30 seconds with Docker and the TypeScript SDK.

1. Run the Server

The Docker image is available on Docker Hub.

docker run -d -p 7654:7654 -p 8080:8080 emanuelepifani/nexo

This exposes:

• Port 7654 (TCP): Main server socket for SDK clients.
• Port 8080 (HTTP): Built-in Web Dashboard — open http://localhost:8080 to inspect all brokers in real-time. No extra tools needed.

Port 8080 is intentionally omitted — the Dashboard is disabled in production mode.

2. Install the SDK

SDK package on npm.

npm install @emanuelepifani/nexo-client

3. Connect & Use

import { NexoClient } from '@emanuelepifani/nexo-client';

// Connect once
const client = await NexoClient.connect({ host: 'localhost', port: 7654 });

// --- Store (Shared state) ---
await client.store.map.set("user:1", { name: "Max", role: "admin" });
const user = await client.store.map.get("user:1");

// --- Pub/Sub (Realtime events) ---
await client.pubsub('alerts').subscribe((msg) => console.log(msg));
await client.pubsub('alerts').publish({ level: "high" });

// --- Queue (Background jobs) ---
const mailQ = await client.queue("emails").create();
await mailQ.push({ to: "test@test.com" });
await mailQ.subscribe((msg) => console.log(msg));

// --- Stream (Event log) ---
const stream = await client.stream('user-events').create();
await stream.publish({ type: 'login', userId: 'u1' });
await stream.subscribe('analytics', (msg) => console.log(msg));

4. Open the Dashboard

Navigate to http://localhost:8080 to access the built-in Web Dashboard. It's included in the container — no extra installations, no external monitoring tools. Inspect stores, monitor queues, trace streams, and debug pub/sub topics in real-time.