Installation

​

Prerequisites

• Node.js 18+ or a compatible runtime
• npm, yarn, or pnpm for package management
• A SnackBase instance (local or hosted)

​

Installation

​

npm

npm install @snackbase/sdk

​

yarn

yarn add @snackbase/sdk

​

pnpm

pnpm add @snackbase/sdk

​

React Integration

npm install @snackbase/sdk react

​

Platform Support

​

TypeScript Support

import { SnackBaseClient } from "@snackbase/sdk";

// Full autocomplete and type safety
const client = new SnackBaseClient({
  baseUrl: "https://your-project.snackbase.dev",
});

​

Bundle Size

• Core SDK: 14.87 KB (gzipped)
• React Integration: 1.42 KB (gzipped)
• Total: 16.29 KB (gzipped)

​

Verification

import { SnackBaseClient } from "@snackbase/sdk";

const client = new SnackBaseClient({
  baseUrl: "https://your-project.snackbase.dev",
});

console.log("SnackBase SDK version:", client.getConfig().version);

​

Next Steps

• Quick Start Guide - Get started with your first query
• Configuration - Explore all configuration options
• Authentication - Learn about authentication methods