Documentation

Everything you need to build, deploy, and scale your applications with BackendKit.

Quickstart Guide API Reference

Quickstart

Get up and running in under 5 minutes with our interactive quickstart guide.

Start Building

Database

Learn how to create tables, query data, and set up Row Level Security policies.

View Docs

Authentication

Implement email/password auth, OAuth providers, and magic links in minutes.

View Docs

Storage

Upload, manage, and serve files with intelligent CDN caching and transformations.

View Docs

Edge Functions

Deploy serverless TypeScript functions globally with automatic scaling.

View Docs

Realtime

Subscribe to database changes, broadcast messages, and track presence in real-time.

View Docs

Quickstart Guide

1. Create a Project

# Create a new project
backendkit init my-project

2. Install the Client Library

Install the JavaScript client library using npm or yarn.

npm install @backendkit/js

3. Initialize the Client

Connect to your BackendKit project using your API credentials.

import { createClient } from '@backendkit/js'

const backendkit = createClient(
  process.env.BACKENDKIT_URL,
  process.env.BACKENDKIT_ANON_KEY
)

4. Query Your Database

Start querying your PostgreSQL database with the auto-generated API.

const { data, error } = await backendkit
  .from('users')
  .select('*')
  .eq('status', 'active')

SDK & Framework Guides

BackendKit works with your favorite frameworks and languages.

⚛️

React

React SDK & hooks

▲

Next.js

SSR & API routes

💚

Vue

Vue 3 composables

🅰️

Angular

Angular services

🦋

Flutter

Dart SDK

🍎

Swift

iOS SDK

🤖

Kotlin

Android SDK

🐍

Python

Python client

Need Help?

Join our Discord community or check out video tutorials on YouTube.

Join Discord Watch Tutorials