Getting Started

Installation

Install Nuxt Realtime in your Nuxt application.

Install the package

pnpm add nuxt-realtime

Add to your config

Add nuxt-realtime to your modules and enable WebSocket support in Nitro:

nuxt.config.ts
export default defineNuxtConfig({
  modules: ['nuxt-realtime'],

  nitro: {
    experimental: {
      websocket: true,
    },
  },
})

That's it. You can now use the realtime composables in your components.

See the Configuration page to set up storage, Redis, Socket.IO options, and key cleanup.

Requirements

  • Nuxt 3.x or Nuxt 4.x
  • Node.js 18+
  • WebSocket support enabled in Nitro

Introduction

Real-time state synchronization for Nuxt applications.

Configuration

Configure storage, Redis, Socket.IO, and key cleanup for Nuxt Realtime.