[JS Bug]: <insert title here>

[srun Domn.]

Please review FAQ and Known issues before filing a new item!

• I have reviewed the FAQ and known issues and did not find my topic

Please note: any submissions with insufficient reproducible information will be marked as 'Waiting for customer input' and may be closed is there is no response

Live Share SDK

 The Live Share SDK builds on the Fluid Framework to enable the creation of collaborative experiences for Microsoft Teams and Microsoft 365. This package focuses on building collaborative meeting applications for Microsoft Teams using Fluid. The SDK provides a LiveShareClient class for connecting to a special Fluid Container associated with each meeting. A collection of Live Share specific Distributed Data Structure (DDS) classes are also provided to simplify building applications for common meeting scenarios like shared media playback.

To get started, we recommend first familiarizing yourself with the Fluid Framework and Live Share overview. You can then follow our Quick Start Guide to build your first Teams Meeting App that uses Live Share.
You can find our detailed API reference documentation at Live Share reference docs and Live Share Media reference docs.

Package Compatibility

The Live Share SDK contains dependencies for @microsoft/teams-js and fluid-framework packages among others. Both of these packages are sensitive to the package version your app any libraries use. You will likely run into issues if the package version your app uses doesn't match the version other libraries you depend on use.

It is critical that your app use the package dependencies listed in the table below. Lookup the version of the @microsoft/live-share you're using and set any other dependencies in your package.json file to match:
@microsoft/live-share@microsoft/teams-jsfluid-framework@microsoft/live-share-*@fluidframework/azure-client@microsoft/TeamsFx@microsoft/TeamsFx-react^1.0.0^2.11.0^1.2.3^1.0.0^1.0.0^2.5.0^2.5.0

Dev Dependencies

Installing

Live Share

To add the latest version of the SDK to your application using NPM:

npm install fluid-framework @fluidframework/azure-client @microsoft/live-share --save

or using Yarn:

yarn add fluid-framework @fluidframework/azure-client @microsoft/live-share

Live Share Media

Optionally, to add the latest version of the media package to your application using NPM:

npm install @microsoft/live-share-media --save

or using Yarn:

yarn add @microsoft/live-share-media

Live Share Canvas

Optionally, to add the latest version of the canvas package (inking & cursors) to your application using NPM:

npm install @microsoft/live-share-canvas --save

or using Yarn:

yarn add @microsoft/live-share-canvas

Live Share integration with React

Optionally, to add the latest version of the React integration to your application using NPM:

npm install @microsoft/live-share-react --save

or using Yarn:

yarn add @microsoft/live-share-react

Contributing

There are several ways you can contribute to this project:

Submit bugs and help us verify fixes as they are checked in.

(Please review FAQ and Known issues before filing a new item!)

Review the source code changes.

Engage with other Live Share developers on StackOverflow.

Contribute bug fixes.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [e-mail] with any additional questions or comments.

Preparing the Repository

To clone the repository to test samples and/or build the packages, ensure that you have the latest versions of Git and Node.js installed.
Clone a copy of the repo:

git clone https://github.com/microsoft/live-share-sdk.git

Change to the live-share-sdk directory:

cd live-share-sdk

Building Packages & Samples

To build the projects packages (with symlinks to the locally built packages), we use npm workspaces to prevent dependency errors.
Install all developer dependencies:

npm install

Build packages and samples:

npm run build

Run the sample of of your choice:

cd samples/javascript/01.dice-roller npm start

Unit tests for all of the packages can be run using npm run test or npm run test:debug. Any previously built files can be deleted prior to building by first running npm run clean.