instantdb.com

# 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](https://instantdb.com/docs/common-mistakes.md): Common mistakes when working with Instant
- [Instant - The Modern Firebase.](https://instantdb.com/docs.md): How to use Instant with React
- [Initializing Instant](https://instantdb.com/docs/init.md): How to integrate Instant with your app.
- [Modeling data](https://instantdb.com/docs/modeling-data.md): How to model data with Instant's schema.
- [Writing data](https://instantdb.com/docs/instaml.md): How to write data with Instant using InstaML.
- [Reading data](https://instantdb.com/docs/instaql.md): How to read data with Instant using InstaQL.
- [Infinite Queries](https://instantdb.com/docs/infinite-queries.md): How to subscribe to large amounts of data incrementally
- [Instant on the Backend](https://instantdb.com/docs/backend.md): How to use Instant on the server with the Admin SDK.
- [Patterns](https://instantdb.com/docs/patterns.md): Common patterns for working with InstantDB.
- [Auth](https://instantdb.com/docs/auth.md): Instant supports magic code, OAuth, Clerk, and custom auth.
- [Magic Code Auth](https://instantdb.com/docs/auth/magic-codes.md): How to add magic code auth to your Instant app.
- [Guest Auth](https://instantdb.com/docs/auth/guest-auth.md): Let your users try your app before creating an account
- [Permissions](https://instantdb.com/docs/permissions.md): How to secure your data with Instant's Rule Language.
- [Rate Limits](https://instantdb.com/docs/rate-limits.md): How to add rate limiting to your Instant app with permission rules.
- [Managing users](https://instantdb.com/docs/users.md): How to manage users in your Instant app.
- [Presence, Cursors, and Activity](https://instantdb.com/docs/presence-and-topics.md): How to add ephemeral features like presence and cursors to your Instant app.
- [Instant CLI](https://instantdb.com/docs/cli.md): How to use the Instant CLI to manage schema and permissions.
- [Storage](https://instantdb.com/docs/storage.md): How to upload and serve files with Instant.
- [Streams](https://instantdb.com/docs/streams.md): How to stream and persist data with Instant.
- [Webhooks](https://instantdb.com/docs/webhooks.md): How to receive, verify, and manage Instant webhooks.
- [Backups](https://instantdb.com/docs/backups.md): How Instant creates backups, how to download them, and what a backup archive contains.
- [Stripe Payments](https://instantdb.com/docs/stripe-payments.md): How to add payments to your Instant app with Stripe.
- [Admin HTTP API](https://instantdb.com/docs/http-api.md): Direct HTTP access to Instant's admin API for non-JavaScript environments.
- [(Experimental) Next.js SSR](https://instantdb.com/docs/next-ssr.md): Use server-side rendering with InstantDB and Next.js.
- [Self hosting](https://instantdb.com/docs/self-hosting.md): Operate Instant on your own infrastructure.
- [Self hosting on VPS](https://instantdb.com/docs/self-hosting/vps.md): Run Instant on a VPS.
- [Self Hosting Instant on AWS](https://instantdb.com/docs/self-hosting/aws.md): Run Instant with multiple backend servers and Aurora PostgreSQL.
- [Migrate from Instant Cloud](https://instantdb.com/docs/self-hosting/migrate.md): Move an Instant Cloud app to self-hosted Instant.


## Optional

- [Getting started with React Native](https://instantdb.com/docs/start-rn.md): How to use Instant with React Native
- [Getting started with Vanilla JS](https://instantdb.com/docs/start-vanilla.md): How to use Instant with Vanilla JS
- [Getting started with SolidJS](https://instantdb.com/docs/start-solidjs.md): How to use Instant with SolidJS
- [Getting started with Svelte](https://instantdb.com/docs/start-svelte.md): How to use Instant with SvelteKit and Svelte 5
- [Getting started with Vue](https://instantdb.com/docs/start-vue.md): How to use Instant with Vue 3 and Vite
- [Getting started with TanStack Start](https://instantdb.com/docs/start-tanstack.md): How to use Instant with TanStack Start
- [Getting started with Python](https://instantdb.com/docs/start-python.md): How to use Instant from Python with the admin SDK.
- [Create Instant App](https://instantdb.com/docs/create-instant-app.md): Use create-instant-app to scaffold a new Instant project
- [Recommended Workflow](https://instantdb.com/docs/workflow.md): How to develop with Instant
- [Using Instant with LLMs](https://instantdb.com/docs/using-llms.md): How to use Instant with LLMs
- [Google OAuth](https://instantdb.com/docs/auth/google-oauth.md): How to add Google OAuth to your Instant app.
- [Sign In with Apple](https://instantdb.com/docs/auth/apple.md): How to add Sign In with Apple to your Instant app.
- [GitHub OAuth](https://instantdb.com/docs/auth/github-oauth.md): How to add GitHub OAuth to your Instant app.
- [LinkedIn OAuth](https://instantdb.com/docs/auth/linkedin-oauth.md): How to add LinkedIn OAuth to your Instant app.
- [Clerk](https://instantdb.com/docs/auth/clerk.md): How to integrate Clerk's auth flow with Instant.
- [Firebase Auth](https://instantdb.com/docs/auth/firebase.md): How to integrate Firebase's auth flow with Instant.
- [Devtool](https://instantdb.com/docs/devtool.md): Use the Instant devtool to inspect your app in development.
- [Platform API](https://instantdb.com/docs/platform-api.md): Spin up Instant apps on demand and manage schema with the Platform API.
- [Explorer Component](https://instantdb.com/docs/explorer-component.md): Use the Explorer Component in your own apps
- [Custom email templates and senders](https://instantdb.com/docs/emails.md): How to customize magic code emails.
- [App teams (Pro)](https://instantdb.com/docs/teams.md): How to manage your Instant app's team members and their roles.