Introduction
Welcome to the platform documentation. This guide will walk you through everything you need to know to get started, from initial setup to advanced configuration. Whether you're building a new project from scratch or integrating into an existing system, you'll find comprehensive guidance here.
Overview
The platform provides a unified API layer for managing data, authentication, and real-time events across your applications. Built with performance and developer experience in mind, it handles the infrastructure complexity so you can focus on building features your users care about.
Quick Start
Get up and running in under five minutes. Install the SDK, configure your API keys, and make your first request.
Core Features
The platform ships with four core capabilities: data management, authentication, real-time events, and file storage.
Next Steps
Now that you understand the basics, explore the guides and API reference to build your integration.
Data Management
CRUD operations, filtering, pagination, and real-time subscriptions on structured data.
Authentication
Email/password, OAuth providers, magic links, and row-level security policies.
Real-time Events
WebSocket-based subscriptions for live data updates across connected clients.
File Storage
Upload, transform, and serve files with built-in CDN and access control.
Install the SDK
npm install @platform/sdk
Configure your client
Initialize with your project URL and API key.
Make your first query
Fetch data from any table with type-safe responses.
import { createClient } from '@platform/sdk'
const client = createClient({
url: process.env.PLATFORM_URL,
key: process.env.PLATFORM_KEY,
})
// Fetch all published posts
const { data, error } = await client
.from('posts')
.select('*')
.eq('status', 'published')
.order('created_at', { ascending: false })