Connector Kit

A framework agnostic wallet connection and state management development kit for Solana applications.

🚀 Quick Start

Prerequisites

• Node.js: Version 18.0.0 or higher
• pnpm: 9.12.3 or higher (recommended package manager)

Installation

1. Clone the repository

   git clone https://github.com/your-username/connector-kit.git
   cd connector-kit

2. Install dependencies

   pnpm install

📦 Available Packages

This monorepo contains several packages:

• @connectorkit/sdk - Core React hooks and utilities for Solana development
• @connectorkit/connector - Wallet connector components and context management
• @connectorkit/providers - Provider templates and configurations
• @connectorkit/jupiter - Jupiter DEX integration example
• @connectorkit/ui-primitives - Headless UI component primitives

🛠️ Development

Available Scripts

# Development
pnpm dev              # Start all apps in development mode
pnpm build            # Build all packages and apps
pnpm test             # Run tests across all packages
pnpm lint             # Lint all code
pnpm type-check       # Run TypeScript type checking
pnpm format           # Format code with Biome

# Package management
pnpm changeset        # Create a changeset for releases
pnpm version-packages # Version packages based on changesets
pnpm release          # Build and publish packages

Development Workflow

1. Start the docs site (includes all examples and demos)

   cd apps/docs
   pnpm dev

   Visit http://localhost:3000 to see the documentation and interactive examples.

2. Work on a specific package

   cd packages/sdk
   pnpm dev    # Start development mode
   pnpm test   # Run tests

3. Build everything

   pnpm build  # From root - builds all packages

🏗️ Project Structure

connector-kit/
├── apps/
│   └── docs/              # Documentation site
├── packages/
│   ├── sdk/               # Core React hooks and utilities
│   ├── connector/         # Connection components
│   ├── providers/         # Provider configurations and templates
│   ├── jupiter/           # Jupiter DEX integration example
│   └── ui-primitives/     # Headless UI components library

🔧 Testing

# Run all tests
pnpm test

# Run tests for specific package
cd packages/sdk
pnpm test

# Run tests in watch mode
pnpm test --watch

✨ Recent Improvements

Documentation Experience

• Collapsible sidebar navigation with smooth animations
• Intelligent section management - relevant sections stay expanded
• Clean, modern interface with improved visual hierarchy
• Enhanced accessibility with proper ARIA labels and keyboard navigation

Developer Experience

• Framework agnostic design - works with React, Vue, Angular, and vanilla JavaScript
• TypeScript-first - comprehensive type definitions for better DX
• Modular architecture - use only what you need
• Extensible theming system - customize appearance to match your brand

🚀 Contributing

We welcome contributions! Please see our Contributing Guide for details on how to get started.

📄 License

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