Skip to Content
Getting StartedInstallation

Installation

The fastest way to get started is with one of our starter templates:

Light Starter (Personal Tools)

npx degit Synap-core/synap-starter my-app
cd my-app && npm install && npm run dev

Perfect for: Personal productivity tools, internal dashboards, rapid MVPs
Features: Vite + React, Design System Studio, BYOK auth

Enterprise Starter (Multi-Tenant SaaS)

npx degit Synap-core/synap-enterprise my-saas
cd my-saas && npm install && npm run dev

Perfect for: SaaS products, team collaboration tools
Features: Next.js 15, Ory Kratos, RBAC, Server Components

Both templates come with pre-configured SDK, Design System Studio, and complete UI components.

Option 2: Manual Installation

New to Synap? Learn about the platform first  before installing the SDK.

Install Synap SDK using your package manager of choice.

Package Managers

npm install @synap/sdk

This will install the SDK along with its peer dependencies:

  • @synap/client - tRPC client
  • @synap/types - Shared types

Requirements

  • Node.js: 18.0.0 or higher
  • TypeScript: 5.0+ (recommended)
  • React: 18.0+ (for React integrations)

Verify Installation

Create a simple test file to verify the SDK is installed correctly:

test.ts
import { SynapSDK } from '@synap/sdk'
 
console.log('Synap SDK loaded successfully!')

Run it with:

npx tsx test.ts

You should see: Synap SDK loaded successfully!

Next Steps

Last updated on
Quick Start