Skip to content

Latest commit

 

History

History
171 lines (112 loc) · 8.52 KB

README.md

File metadata and controls

171 lines (112 loc) · 8.52 KB
Raw
page_type description products languages extensions urlFragment
sample
This sample demos live coding in a teams meeting stage using live share SDK. The tab is loaded as side panel which contains various coding questions.
office-teams
office
office-365
nodejs
javascript
contentType createdDate
samples
03/24/2022 12:00:00 AM
officedev-microsoft-teams-samples-meetings-live-code-interview-nodejs

Live coding interview using Shared meeting stage

This sample demos a live coding in a Teams meeting stage using Live Share SDK. In side panel there is a list of question in specific coding language and on share click specific question with language code editor will be shared with other participant in meeting. Now any participant in meeting can write code for the question and same will be updated to all the other participants in meeting.

Included Features

  • Meeting Stage
  • Meeting SidePanel
  • Live Share SDK
  • RSC Permissions

Interaction with app

side panel

Try it yourself - experience the App in your Microsoft Teams client

Please find below demo manifest which is deployed on Microsoft Azure and you can try it yourself by uploading the app package (.zip file link below) to your teams and/or as a personal app. (Sideloading must be enabled for your tenant, see steps here).

Live coding interview using Shared meeting stage: Manifest

Prerequisites

Run the app (Using Teams Toolkit for Visual Studio Code)

The simplest way to run this sample in Teams is to use Teams Toolkit for Visual Studio Code.

  1. Ensure you have downloaded and installed Visual Studio Code
  2. Install the Teams Toolkit extension
  3. Select File > Open Folder in VS Code and choose this samples directory from the repo
  4. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps
  5. Select Debug > Start Debugging or F5 to run the app in a Teams web client.
  6. In the browser that launches, select the Add button to install the app to Teams.

If you do not have permission to upload custom apps (sideloading), Teams Toolkit will recommend creating and using a Microsoft 365 Developer Program account - a free program to get your own dev environment sandbox that includes Teams.

Workflow

sequenceDiagram

    Teams User->>+Teams Client: Schedules a Teams Meeting with candidate

    Teams Client->>+Live Coding App: Installs the App

    Teams User->>+Teams Client: Starts the meeting

    Teams User->>+Live Coding App: Opens the Live coding app side panel

    Live Coding App->>+Side Panel: Load questions

    Side Panel-->>-Live Coding App: Loads predefined coding questions

    Teams User->>+Side Panel: Select the coding question to share to stage

    Side Panel-->>-Teams Client: Tells the team client to open a code editor on the stage

    Teams Client->>+Code Editor Stage: Tells the app which coding question to open

    Code Editor Stage-->>-Live Coding App: Shares the question to share to stage in the meeting
Loading

Setup

  1. Register a new application in the Microsoft Entra ID – App Registrations portal.

    • Your app must be registered in the Azure AD portal to integrate with the Microsoft identity platform and call Microsoft Graph APIs. See Register an application with the Microsoft identity platform.
    • You need to add following permissions mentioned in the below screenshots to call respective Graph API

NOTE: When you create app registration, you will create an App ID and App password - make sure you keep these for later.

  1. Setup NGROK

  • Run ngrok - point to port 3978

    ngrok http 3978 --host-header="localhost:3978"

    Alternatively, you can also use the dev tunnels. Please follow Create and host a dev tunnel and host the tunnel with anonymous user access command as shown below:

    devtunnel host -p 3978 --allow-anonymous
  1. Setup for code

  • Clone the repository

    git clone https://github.com/OfficeDev/Microsoft-Teams-Samples.git

Install node modules

Inside node js folder, navigate to samples/meetings-live-code-interview/nodejs/api open your local terminal and run the below command to install node modules. You can do the same in Visual Studio code terminal by opening the project in Visual Studio code.

  • Repeat the same step in folder samples/meetings-live-code-interview/nodejs
```bash
npm install
```

  • We have two different solutions to run so follow below steps:

    A) In a terminal, navigate to samples/meetings-live-code-interview/nodejs/api

    B) In a different terminal, navigate to samples/meetings-live-code-interview/nodejs

  • Run both solutions i.e. samples/meetings-live-code-interview/nodejs/api and samples/meetings-live-code-interview/nodejs

    npm start
  1. Setup Manifest for Teams

  • This step is specific to Teams.

    • Edit the manifest.json contained in the ./appPackage folder to replace your Microsoft App Id (that was created when you registered your app registration earlier) everywhere you see the place holder string {{Microsoft-App-Id}} (depending on the scenario the Microsoft App Id may occur multiple times in the manifest.json)
    • Edit the manifest.json for validDomains and replace {{domain-name}} with base Url of your domain. E.g. if you are using ngrok it would be https://1234.ngrok-free.app then your domain-name will be 1234.ngrok-free.app and if you are using dev tunnels then your domain will be like: 12345.devtunnels.ms.
    • Zip up the contents of the appPackage folder to create a manifest.zip (Make sure that zip file does not contains any subfolder otherwise you will get error while uploading your .zip package)

  • Upload the manifest.zip to Teams (in the Apps view click "Upload a custom app")

    • Go to Microsoft Teams. From the lower left corner, select Apps
    • From the lower left corner, choose Upload a custom App
    • Go to your project directory, the ./appPackage folder, select the zip folder, and choose Open.
    • Select Add in the pop-up dialog box. Your app is uploaded to Teams.

Note Run the app on Teams with developer preview on.

Running the sample

Side panel view: side panel

Question view on click of share: shared content

Question view for other participant in meeting: shared content second user

Further reading