This project hosts samples for SuperViz SDK. To find out more about the SDK itself, please visit the documentation.
The SDK documentation has extensive sections about getting started, setting up the SDK, as well as the process of acquiring the required developer key. You will need Developer Key keys to run the samples on your machines, you therefore should follow the instructions on these pages before continuing.
Every sample is a standalone project and can be built and run independently. The samples, in the js/ directory are written in JavaScript. The samples in the ts/ directory are written in TypeScript. Both can be built and run using the following commands:
npm install
npm startor with Yarn:
yarn install
yarn startJust make sure that you have the required developer keys in the .env file. For that copy the .env.example file to .env and fill in the values.
NOTE: inside the js/ directory you can find the cnd/ directory, this contains samples using our SDK with CDN, meaning that the SuperViz package is downloaded from <script type="module" src="https://unpkg.com/@superviz/sdk@latest"></script> and not using it as a package. It only has a package.json to run a local server, which can also be done with other tools.
| Component | CDN | Vanilla | React |
|---|---|---|---|
| Mouse Pointer | 🔗 | 🔗 | 🔗 |
| Forms Elements | 🔗 | 🔗 | 🔗 |
| Real-time Data Engine | 🔗 | 🔗 | |
| Presence3D for Autodesk | 🔗 | 🔗 | 🔗 |
| Presence3D for Matteport | 🔗 | 🔗 | 🔗 |
| Presence3D for ThreeJS | 🔗 | 🔗 | 🔗 |
| Contextual Comments with Canvas Pin | 🔗 | 🔗 | 🔗 |
| Contextual Comments with HTML Pin | 🔗 | 🔗 | 🔗 |
| Contextual Comments with AutoDesk | 🔗 | 🔗 | 🔗 |
| Contextual Comments with Matteport | 🔗 | 🔗 | 🔗 |
| Contextual Comments with ThreeJS | 🔗 | 🔗 | 🔗 |
| Video Conference | 🔗 | 🔗 | 🔗 |
| Who-is-Online | 🔗 | 🔗 | 🔗 |
| Yjs Provider with Monaco | 🔗 | 🔗 | |
| Yjs Provider with Quill | 🔗 | 🔗 |
| Component | Vanilla | React |
|---|---|---|
| Mouse Pointer | 🔗 | 🔗 |
| Forms Elements | 🔗 | 🔗 |
| Real-time Data Engine | 🔗 | |
| Presence for Autodesk | 🔗 | 🔗 |
| Presence for Matteport | 🔗 | 🔗 |
| Presence for ThreeJS | 🔗 | 🔗 |
| Contextual Comments with Canvas Pin | 🔗 | 🔗 |
| Contextual Comments with HTML Pin | 🔗 | 🔗 |
| Contextual Comments with AutoDesk | 🔗 | 🔗 |
| Contextual Comments with Matteport | 🔗 | 🔗 |
| Contextual Comments with ThreeJS | 🔗 | 🔗 |
| Video Conference | 🔗 | 🔗 |
| Who-is-Online | 🔗 | 🔗 |
| Yjs Provider with Monaco | 🔗 | 🔗 |
| Yjs Provider with Quill | 🔗 | 🔗 |
These are the key features we are working on right now:
- Samples with Vue for both JavaScript and TypeScript - planned
After that, we will be working on bringing the samples to more libraries and frameworks, such as Svelte and Angular.
Besides samples, we want this project to:
- GitOps to update the SuperViz SDK version before (in a separate branch) and after a new version is released - in progress
- User Interface Automatic Tests - planned