Skip to main content
Get your web application connected to social.plus in just a few steps. This guide covers everything from installation to your first authenticated session.

​
Requirements

​
Browser Support

  • Chrome 38+
  • Firefox 42+
  • Safari 9+
  • Microsoft Edge 13+
  • Opera 25+
Internet Explorer 11 is not supported. The SDK requires modern browser features.

​
Framework Compatibility

React Applications

  • Create React App
  • Next.js (client-side)
  • Vite React
  • Custom React setups

Vue Applications

  • Vue 3 composition API
  • Vue 2 options API
  • Nuxt.js (client-side)
  • Vite Vue

Angular Applications

  • Angular 12+
  • Angular CLI projects
  • Nx workspaces
  • Custom Angular setups

Other Frameworks

  • React Native
  • Svelte/SvelteKit
  • Solid.js
  • Lit Framework

​
Installation

npm install @amityco/ts-sdk --save

​
Initialize the SDK

Create the client with your API key and region so the SDK is ready for authentication. 
import { Client } from '@amityco/ts-sdk';

const client = Client.createClient({
  apiKey: 'YOUR_API_KEY',
  region: 'sg',
});
This creates the SDK client but does not yet authenticate a user. See Authentication for the next step.

​
Next Steps

Authentication Guide

Learn about session management and secure authentication flows

Chat Features

Start building chat and messaging features

Social Features

Add posts, feeds, and social interactions

Video Streaming

Implement live video and streaming features

​
Troubleshooting

Module not found: Make sure you’ve installed the package correctly with your package managerTypeScript errors: Ensure you’re using TypeScript 3.7+ and have proper type definitionsBuild errors: Check that your bundler supports ES6 modules and async/await
Network failures: Verify your API key and region settingsAuthentication errors: Check that your auth token is valid and not expiredMemory leaks: Always call client.logout() when your app unmounts
Older browsers: Make sure you’ve included the required polyfillsSafari issues: Ensure you’re using HTTPS in production (required for WebRTC features)