README.md

SuperViz provides a suite of programmable low-code Collaboration and Communication components, all synchronized with an advanced Real-time Data Engine, enabling real-time and asynchronous collaboration and communication within any JavaScript based application.

SuperViz offers a comprehensive suite of components, all synchronized with an advanced Real-time Data Engine, facilitating real-time collaboration in JavaScript-based applications. SuperViz SDK enables you to use one of our components:

• Contextual Comments
  • Contextual Comments for HTML
  • Contextual Comments for Canvas element
  • Contextual Comments for Autodesk
  • Contextual Comments for Matterport
  • Contextual Comments for ThreeJS
• Presence
  • Real-time Mouse Pointers
  • Real-time Data Engine
  • Who-is-Online
  • Presence in Autodesk
  • Presence in Matterport
  • Presence in ThreeJS
• Video Conference

You can also combine components to create a custom solution for your application.

How to start coding with SuperViz? After installing this package, you’ll need to create an account to retrieve a SuperViz Token and start coding.

Quickstart

1. Installation

Install SuperViz SDK in your Node.js powered apps with the npm package:

npm install --save @superviz/sdk

Or, with yarn:

yarn add @superviz/sdk

2. Import the SDK

Once installed, import the SDK to your code:

import SuperVizSdk from '@superviz/sdk';

3. Initialize the SDK

After importing the SDK, you can initialize passing your DEVELOPER_KEY as a parameter and the options object. You can see details for the options object on the SDK Initialization page.

The SuperViz SDK is your primary gateway to access all SDK features, offering the essential methods to add its components.

async function initializeSuperVizSdk() {
  const sdk = await SuperVizSdk(DEVELOPER_KEY, {
    roomId: '<ROOM-ID>',
    group: {
      id: '<GROUP-ID>',
      name: '<GROUP-NAME>',
    },
    participant: {
      id: '<USER-ID>',
      name: '<USER-NAME>',
    },
  });

  return sdk;
}

If you are implementing the SuperViz SDK in a React application, check our React SDK package, which provides a set of hooks and components to make it easier to integrate SuperViz SDK into your React application.

Documentation

You can find the complete documentation for every component and how to initialize them on the SuperViz SDK Documentation page.

You can also find the complete changelog on the Release Notes page.

Contributing

If you are interested in contributing to SuperViz SDK, the best place to get involved with the community is through the Discord server, there you can find the latest news, ask questions, and share your experiences with SuperViz SDK.

License

SuperViz SDK is licensed under the BSD 2-Clause License.