README.md

SDK Examples

• SDK Examples
  • Prerequisites
  • Setup monorepo root
  • Setup packages
  • Run packages
  • Clean packages
  • Make a prod build
  • Packages
    • vs-app
    • rc-app
    • inspector
    • easter
    • embed examples
    • common
    • core
    • bundle
  • License

Prerequisites

Your development environment will need node.js and yarn installed.

See https://nodejs.org/en/ and https://classic.yarnpkg.com/en/docs/install for installation instructions specific to your environment.

To run these examples, you will need to generate a sandboxed sdk key for your Matterport account. See Matterport Developer Tools Pricing and Availability.

You will need to insert your SDK Key into the following line in packages/common/src/index.ts:

export const sdkKey = 'YOUR SDK KEY HERE';

Setup Monorepo

Run these two commands when you first download the repo.

> yarn install
> yarn install-bundle

Setup packages

Call this to install or update the package dependencies. It also links local packages together.

> yarn bootstrap

Run packages

All packages can run in a development environment by their respective names:

> yarn inspector
> yarn vs-app
> yarn easter
> yarn rc-app
> yarn embed-examples

Clean packages

You will need to bootstrap after cleaning.

> yarn clean

Make a prod build

> yarn build-all-prod

Packages

The repository is a Lerna monorepo. This means that the package.json dependencies at the root of the repository are shared with each of the individual packages. Please keep in mind that not all root-level dependencies are used by all examples. The packages include:

vs-app

frameworks: Reactjs + SDK Bundle

• virtual staging
• local webcam
• canvas
• security camera

rc-app

frameworks: Reactjs + Photon SDK + SDK for Embeds

• an example that shows how to build a remote controlled showcase

inspector

frameworks: Reactjs + RxJS + SDK Bundle

• Object placement using sdk scene files

easter

frameworks: Reactjs + Phaser + SDK Bundle

• Hidden object minigame

embed-examples

frameworks: Vanilla JS + SDK for Embeds

• Sensor - Point Areas
• Sensor - Sweep Controls
• Sensor - Tags Level of Details
• Sensor - Tags per Sweep
• Training Tags Demo - Training Application
• Training Tags Overlay Demo - Training Application

common

• Reusable SDK Bundle components

core

• Matterport observable library

bundle

• Showcase SDK Bundle is created when running yarn install-bundle and used by the examples

License

See the MATTERPORT SAMPLE SDK CODE LICENSE AGREEMENT file for license rights and limitations for this repository.