Threekit Remote Configuration

This client/server is an example of how to facilitate remote configuration with a Threekit configurator.

Installation

Server

npm install

npm start

Client

Create your .env file and enter your credentials:

TRBL_DEBUG=true
TRBL_THREEKIT_ENV='preview'

# Threekit Credentials
# Environment - Preview
THREEKIT_PREVIEW_ORG_ID=
THREEKIT_PREVIEW_PUBLIC_TOKEN=

# Environment - Admin-FTS
THREEKIT_ADMIN_FTS_ORG_ID=
THREEKIT_ADMIN_FTS_PUBLIC_TOKEN=

yarn install

yarn start

How it works

The client will be available on localhost, I will assume for this guide that it is runing on http://localhost:3000

The client can take in two parameters: http://localhost:3000?room=ROOM_ID&mode=MODE

Sessions are grouped into 'rooms' that have matching IDs and there can be many users in each room. An example of two users connected to the same session, one as a viewer and one as a configure-er would be as follows.

One device: http://localhost:3000?room=123&mode=viewer

Second device: http://localhost:3000?room=123&mode=config