Getting started
Choose your app’s setup guide. You’ll add the plugin, create a client and render a subscription. The examples connect to your existing API; no Spinetab backend is required.
Choose your setup
Section titled “Choose your setup”Using another build tool? Add its plugin, then follow the component recipe for your framework:
| Your app | Build setup | Component setup |
|---|---|---|
| webpack | webpack plugin | Using subscriptions |
| Rspack | Rspack plugin | Using subscriptions |
| Vanilla JavaScript or TypeScript | Your bundler’s plugin | Vanilla JavaScript |
Connect your existing API
Section titled “Connect your existing API”The setup guides let you switch between polling, SSE, WebSocket and fetch streams without rewriting the component. For GraphQL, Socket.IO or an existing data library, choose your integration: it shows which sources fit each library and where to connect them in your framework.
Keep your library’s hooks and providers when using an integration. You do not need to add Spinetab’s value hooks as well.
Before you deploy
Section titled “Before you deploy”- Set up authentication and user scopes if the feed contains user-specific data.
- Choose how the app recovers missed events. Reconnecting alone cannot recover data the server did not replay.
- Check deployment requirements and compatibility.
Custom decoders, protocol handlers and runtime settings belong in a custom worker. You can add one later without changing how your components subscribe.