https://github.com/superviz/sdk

SuperViz provides programmable low-code Collaboration and Communication components for web applications.
https://github.com/superviz/sdk

Last synced: 6 days ago
JSON representation

SuperViz provides programmable low-code Collaboration and Communication components for web applications.

• Host: GitHub
• URL: https://github.com/superviz/sdk
• Owner: SuperViz
• License: bsd-2-clause
• Created: 2022-06-29T18:04:54.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-22T13:22:00.000Z (6 months ago)
• Last Synced: 2024-05-22T19:00:17.253Z (6 months ago)
• Language: TypeScript
• Homepage: https://docs.superviz.com/
• Size: 11 MB
• Stars: 15
• Watchers: 5
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  





  

  

  

  

  

  

  



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](https://docs.superviz.com/sdk/comments/html-adapter)

  - [Contextual Comments for Canvas element](https://docs.superviz.com/sdk/comments/canvas-adapter)

  - [Contextual Comments for Autodesk](https://docs.superviz.com/sdk/comments/autodesk-adpater)

  - [Contextual Comments for Matterport](https://docs.superviz.com/sdk/comments/matterport-adapter)

  - [Contextual Comments for ThreeJS](https://docs.superviz.com/sdk/comments/threejs-adapter)

- Presence

  - [Real-time Mouse Pointers](https://docs.superviz.com/sdk/presence/mouse-pointers)

  - [Real-time Data Engine](https://docs.superviz.com/sdk/presence/real-time-data-engine)

  - [Who-is-Online](https://docs.superviz.com/sdk/presence/who-is-online)

  - [Presence in Autodesk](https://docs.superviz.com/sdk/presence/AutodeskPresence)

  - [Presence in Matterport](https://docs.superviz.com/sdk/presence/MatterportPresence)

  - [Presence in ThreeJS](https://docs.superviz.com/sdk/presence/ThreeJsPresence)

- [Video Conference](https://docs.superviz.com/sdk/video/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](https://dashboard.superviz.com/) to retrieve a SuperViz Token and start coding.

## Quickstart

### 1. Installation

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

```bash

npm install --save @superviz/sdk

```

Or, with yarn:

```bash

yarn add @superviz/sdk

```

### 2. Import the SDK

Once installed, import the SDK to your code:

```jsx

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](https://docs.superviz.com/init/initialization).

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

```jsx

async function initializeSuperVizSdk() {

  const sdk = await SuperVizSdk(DEVELOPER_KEY, {

    roomId: '',

    group: {

      id: '',

      name: '',

    },

    participant: {

      id: '',

      name: '',

    },

  });

  return sdk;

}

```

If you are implementing the SuperViz SDK in a React application, check our [React SDK package](https://docs.superviz.com/react-sdk/initialization), 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](https://docs.superviz.com/).

You can also find the complete changelog on the [Release Notes page](https://docs.superviz.com/releases).

## Contributing

If you are interested in contributing to SuperViz SDK, the best place to get involved with the community is through the [Discord server](https://discord.gg/weZ3Bfv6WZ), 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](LICENSE).