Skip to main content

​
Prerequisites

Before installing Databite SDK, ensure you have:
  • Node.js >= 16.0.0
  • TypeScript >= 4.5.0 (recommended)
  • npm, yarn, pnpm, or bun package manager

​
Core Installation

Install the essential Databite packages: 
npm install @databite/build @databite/flow @databite/types
These three packages are the core of the Databite SDK and are required for most use cases.

​
Additional Packages

Install additional packages based on your needs:

​
React Integration

For React applications with UI components: 
npm install @databite/connect
Peer Dependencies: 
npm install react react-dom

​
Pre-built Connectors

For ready-to-use connectors: 
npm install @databite/connectors

​
Data Synchronization

For automated data synchronization: 
npm install @databite/engine
Peer Dependencies: 
npm install bullmq

​
AI Connector Generation

For AI-powered connector generation: 
npm install @databite/ai

​
Package Manager Options

​
npm

# Core packages
npm install @databite/build @databite/flow @databite/types

# Additional packages
npm install @databite/connect @databite/connectors @databite/engine @databite/ai

​
yarn

# Core packages
yarn add @databite/build @databite/flow @databite/types

# Additional packages
yarn add @databite/connect @databite/connectors @databite/engine @databite/ai

​
pnpm

# Core packages
pnpm add @databite/build @databite/flow @databite/types

# Additional packages
pnpm add @databite/connect @databite/connectors @databite/engine @databite/ai

​
bun

# Core packages
bun add @databite/build @databite/flow @databite/types

# Additional packages
bun add @databite/connect @databite/connectors @databite/engine @databite/ai

​
TypeScript Configuration

Ensure your tsconfig.json includes the necessary compiler options: 
{
  "compilerOptions": {
    "target": "ES2020",
    "lib": ["ES2020", "DOM"],
    "module": "ESNext",
    "moduleResolution": "node",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true,
    "resolveJsonModule": true,
    "allowSyntheticDefaultImports": true
  }
}

​
Environment Setup

​
Node.js Environment

For server-side usage: 
// No additional setup required
import { createConnector } from "@databite/build";

​
Browser Environment

For client-side usage with React: 
import { ConnectModal } from "@databite/connect";
import { createFlow } from "@databite/flow";

​
Next.js

For Next.js applications: 
// pages/api/connectors.ts
import { createConnector } from "@databite/build";

// components/ConnectButton.tsx
import { ConnectModal } from "@databite/connect";

​
Verification

Test your installation by creating a simple connector: 
import { createConnector } from "@databite/build";
import { z } from "zod";

const testConnector = createConnector()
  .withIdentity("test", "Test Connector")
  .withVersion("1.0.0")
  .withAuthor("Test")
  .withDescription("Test connector")
  .withIntegrationConfig(z.object({}))
  .withConnectionConfig(z.object({}))
  .build();

console.log("Databite SDK installed successfully!");

​
Troubleshooting

​
Common Issues

Ensure you have TypeScript >= 4.5.0 installed and properly configured. Check your tsconfig.json for the correct compiler options.
Install the required peer dependencies for the packages you’re using. Each package’s documentation lists its peer dependencies.
Make sure your tsconfig.json has "moduleResolution": "node" and "esModuleInterop": true enabled.
If using @databite/connect, ensure you’re using React 16.8+ and have react and react-dom installed.

​
Getting Help

If you encounter issues:
  1. Check the Common Issues guide
  2. Review the Debugging guide
  3. Join our Discord community
  4. Open an issue on GitHub

​
Next Steps

Quickstart Guide

Build your first connector

Package Documentation

Explore detailed package documentation
⌘I