---
title: "Getting started"
url: "https://spinetab.com/docs/getting-started/"
description: "Set up Spinetab in Vite, Next.js, Astro, Nuxt, SvelteKit or React Router, then connect your API."
---

# 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.

Working with a coding agent? [Copy a setup prompt and give it the docs](https://spinetab.com/docs/using-agents.md).

## Choose your setup

[Vite](https://spinetab.com/docs/setup/vite.md) Add the plugin to a React, Vue, Svelte or Solid app.

[Next.js](https://spinetab.com/docs/setup/nextjs.md) Wrap your config and add a live App Router Client Component.

[Astro](https://spinetab.com/docs/setup/astro.md) Add the integration and hydrate a live island.

[Nuxt](https://spinetab.com/docs/setup/nuxt.md) Add the Nuxt module and subscribe from a Vue page.

[SvelteKit](https://spinetab.com/docs/setup/sveltekit.md) Add the Vite plugin and read live values with a Svelte store.

[React Router](https://spinetab.com/docs/setup/react-router.md) Add the Vite plugin and subscribe from a route component.

Using another build tool? Add its plugin, then follow the component recipe for your framework:

| Your app | Build setup | Component setup |
| --- | --- | --- |
| webpack | [webpack plugin](https://spinetab.com/docs/bundlers.md#webpack) | [Using subscriptions](https://spinetab.com/docs/frameworks.md) |
| Rspack | [Rspack plugin](https://spinetab.com/docs/bundlers.md#rspack) | [Using subscriptions](https://spinetab.com/docs/frameworks.md) |
| Vanilla JavaScript or TypeScript | [Your bundler’s plugin](https://spinetab.com/docs/bundlers.md) | [Vanilla JavaScript](https://spinetab.com/docs/frameworks.md#vanilla-javascript) |

## 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](https://spinetab.com/docs/choose-integration.md): 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

-   Set up [authentication and user scopes](https://spinetab.com/docs/concepts/credentials.md) if the feed contains user-specific data.
-   Choose how the app [recovers missed events](https://spinetab.com/docs/concepts/continuity.md). Reconnecting alone cannot recover data the server did not replay.
-   Check [deployment requirements](https://spinetab.com/docs/deployment.md) and [compatibility](https://spinetab.com/docs/compatibility.md).

Custom decoders, protocol handlers and runtime settings belong in a [custom worker](https://spinetab.com/docs/your-worker.md). You can add one later without changing how your components subscribe.
