Skip to content

README.md

Latest commit

 

History

History
155 lines (109 loc) · 5.04 KB

README.md

File metadata and controls

155 lines (109 loc) · 5.04 KB

Databite SDK

Databite SDK Hero

A comprehensive TypeScript SDK for building, managing, and executing connectors to third-party APIs. The Databite SDK provides a powerful, type-safe way to create integrations with external services, manage data synchronization, and build robust data pipelines.

🏗️ Architecture

The Databite SDK is built as a modular monorepo with the following packages:

databite/
├── packages/
│   ├── build/          # Core SDK for building connectors
│   ├── connect/        # React components for UI integration
│   ├── connectors/     # Pre-built connector library
│   ├── dashboard/      # Web dashboard for monitoring server performance
│   ├── engine/         # Data synchronization and execution engine
│   ├── server/         # Express server with API endpoints
│   ├── types/          # Shared TypeScript types
│   ├── example-webapp/ # Example Next.js web application
│   └── example-server/ # Example Express server

📦 Packages

🚀 Quick Start

Installation

# Install core packages
npm install @databite/server @databite/connect

# Install additional packages as needed
npm install @databite/connectors @databite/engine @databite/build @databite/types

Basic Usage

import { createConnector, createAction } from "@databite/build";
import { z } from "zod";

// Create a connector
const myConnector = createConnector()
  .withIdentity("my-service", "My Service")
  .withVersion("1.0.0")
  .withAuthor("Your Name")
  .withLogo("https://example.com/logo.png")
  .withDescription("Connector for My Service")
  .build();

🎯 Key Concepts

Three-Tier Hierarchy

  1. Connector - A template/blueprint that defines what properties and configurations are available for a service
  2. Integration - An instance of a connector where configuration values have been filled in
  3. Connection - When someone actually uses an integration to connect to a service

Core Features

  • 🔧 Connector Builder: Fluent API for defining connectors with full TypeScript support
  • ⚡ Auth Flow: Execute complex authentication and data workflows with automatic type inference
  • 🔄 Sync Engine: Handle recurring data synchronization with scheduling
  • 🎨 React Components: Pre-built UI components for easy integration
  • 🚀 Server: Ready-to-use server with RESTful API endpoints

📚 Documentation

Package Documentation

🛠️ Development

Prerequisites

  • Node.js >= 16.0.0
  • TypeScript >= 4.5.0
  • npm or yarn

Setup

# Clone the repository
git clone https://github.com/DatabiteDev/databite.git
cd databite

# Install dependencies
pnpm install

# Build all packages
pnpm run build:all

# Run tests
pnpm test

🚀 Release Workflow

Creating a Changeset

To document changes for a release:

# Create a changeset describing changes
pnpm changeset

Publishing a Release

When ready to release:

# When ready to release:
pnpm release

🤝 Contributing

We welcome contributions! Please see our Contributing Guide for details.

📋 Code of Conduct

This project adheres to a Code of Conduct to ensure a welcoming and inclusive environment for all contributors and community members. We are committed to providing a harassment-free experience for everyone, regardless of background, identity, or experience level.

Please read our Code of Conduct to understand our community guidelines and expectations for participation.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🆘 Support