StarStream: Real-time Collaboration for StarHTML

StarStream provides a "convention over configuration" approach to real-time features in StarHTML. Follow these instructions to implement synchronized user experiences.

Core Integration Strategy

When tasked with adding real-time features, always follow this workflow:

1. Identify Features: Determine if the app needs simple broadcasting, persistence (PocketBase), or conflict-free editing (Loro).
2. Initialize Core: Add StarStreamPlugin(app) to the main application file.
3. Enable Modules: Toggle enable_presence, enable_typing, enable_cursor, or enable_history as needed.
4. Register SSE: Ensure a /stream route exists to provide the EventSource connection.
5. Emit Events: Use yield elements(...) in @sse routes to auto-broadcast UI updates.

Basic Initialization

from starhtml import *
from starstream import StarStreamPlugin