InstantDB

Instant is a modern Firebase. We make you productive by giving your frontend a real-time database. Below is a reference for documentation on using Instant.

Docs

• Common mistakes: Common mistakes when working with Instant
• Instant - The Modern Firebase.: How to use Instant with React
• Initializing Instant: How to integrate Instant with your app.
• Modeling data: How to model data with Instant's schema.
• Writing data: How to write data with Instant using InstaML.
• Reading data: How to read data with Instant using InstaQL.
• Infinite Queries: How to subscribe to large amounts of data incrementally
• Instant on the Backend: How to use Instant on the server with the Admin SDK.
• Patterns: Common patterns for working with InstantDB.
• Auth: Instant supports magic code, OAuth, Clerk, and custom auth.
• Magic Code Auth: How to add magic code auth to your Instant app.
• Guest Auth: Let your users try your app before creating an account
• Permissions: How to secure your data with Instant's Rule Language.
• Rate Limits: How to add rate limiting to your Instant app with permission rules.
• Managing users: How to manage users in your Instant app.
• Presence, Cursors, and Activity: How to add ephemeral features like presence and cursors to your Instant app.
• Instant CLI: How to use the Instant CLI to manage schema and permissions.
• Self Hosting: Run InstantDB entirely on your own server.
• Storage: How to upload and serve files with Instant.
• Streams: How to stream and persist data with Instant.
• Webhooks: How to receive, verify, and manage Instant webhooks.
• Stripe Payments: How to add payments to your Instant app with Stripe.
• Admin HTTP API: Direct HTTP access to Instant's admin API for non-JavaScript environments.
• (Experimental) NextJS SSR: Use server-side-rendering with InstantDB and Next.js.

Optional

• Getting started with React Native: How to use Instant with React Native
• Getting started with Vanilla JS: How to use Instant with Vanilla JS
• Getting started with SolidJS: How to use Instant with SolidJS
• Getting started with Svelte: How to use Instant with SvelteKit and Svelte 5
• Getting started with Vue: How to use Instant with Vue 3 and Vite
• Getting started with TanStack Start: How to use Instant with TanStack Start
• Create Instant App: Use create-instant-app to scaffold a new Instant project
• Recommended Workflow: How to develop with Instant
• Using Instant with LLMs: How to use Instant with LLMs
• Google OAuth: How to add Google OAuth to your Instant app.
• Sign In with Apple: How to add Sign In with Apple to your Instant app.
• GitHub OAuth: How to add GitHub OAuth to your Instant app.
• LinkedIn OAuth: How to add LinkedIn OAuth to your Instant app.
• Clerk: How to integrate Clerk's auth flow with Instant.
• Firebase Auth: How to integrate Firebase's auth flow with Instant.
• Devtool: Use the Instant devtool to inspect your app in development.
• Platform API: Spin up Instant apps on demand and manage schema with the Platform API.
• Explorer Component: Use the Explorer Component in your own apps
• Custom email templates and senders: How to customize magic code emails.
• App teams (Pro): How to manage your Instant app's team members and their roles.
• Migrating from Supabase: A prompt for your AI coding assistant to migrate a Supabase project to InstantDB.