Installation Guide

Detailed instructions for installing and setting up the SDK.

System Requirements

  • Node.js: Version 18.0.0 or higher
  • npm/yarn/pnpm: Latest version
  • Operating System: macOS, Linux, or Windows

Installation Methods

npm

bash
npm install @your-sdk/core

yarn

bash
yarn add @your-sdk/core

pnpm

bash
pnpm add @your-sdk/core

Framework-Specific Installation

React

bash
npm install @your-sdk/react

Next.js

bash
npm install @your-sdk/next

Vue

bash
npm install @your-sdk/vue

Verification

  1. Confirm the package is installed

    Run:

    bash
    npm list @your-sdk/core

    You should see the installed version with no missing dependency errors.

  2. Smoke test in Node

    In a small script or REPL, import the client and instantiate it with a placeholder key to ensure the module resolves (no network call required).

  3. Align versions across workspace

    If you use monorepos or multiple packages, pin the same SDK major version everywhere to avoid duplicate or conflicting installs.

Troubleshooting

Common Issues

Issue: Module not found

  • Solution: Ensure you're using Node.js 18+ and have run npm install

Issue: TypeScript errors

  • Solution: Install TypeScript types: npm install --save-dev @types/node

Issue: Build errors

  • Solution: Clear node_modules and reinstall: rm -rf node_modules && npm install

Next Steps

Is this page helpful?

Previous |Quick Start
Next |Configuration