page_type | description | products | languages | extensions | urlFragment | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
sample |
This sample application demonstrates live coding interviews in Microsoft Teams using the Live Share SDK, enabling participants to collaboratively solve coding questions in real time. |
|
|
|
officedev-microsoft-teams-samples-meetings-live-code-interview-nodejs |
This sample application facilitates live coding interviews in Microsoft Teams using the Live Share SDK. Featuring a side panel that lists coding questions, it allows participants to engage in real-time coding challenges, ensuring an interactive and collaborative experience during technical interviews.
- Meeting Stage
- Meeting SidePanel
- Live Share SDK
- RSC Permissions
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
-
Office 365 tenant. You can get a free tenant for development use by signing up for the Office 365 Developer Program.
-
To test locally, NodeJS must be installed on your development machine (version 16.14.2 or higher).
-
dev tunnel or ngrok latest version or equivalent tunnelling solution
The simplest way to run this sample in Teams is to use Teams Toolkit for Visual Studio Code.
- Ensure you have downloaded and installed Visual Studio Code
- Install the Teams Toolkit extension
- Select File > Open Folder in VS Code and choose this samples directory from the repo
- Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps
- Select Debug > Start Debugging or F5 to run the app in a Teams web client.
- 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.
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
-
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.
- 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
- 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
andsamples/meetings-live-code-interview/nodejs
npm start
- 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 themanifest.json
) - Edit the
manifest.json
forvalidDomains
and replace{{domain-name}}
with base Url of your domain. E.g. if you are using ngrok it would behttps://1234.ngrok-free.app
then your domain-name will be1234.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 amanifest.zip
(Make sure that zip file does not contains any subfolder otherwise you will get error while uploading your .zip package)
- Edit the
-
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.
Question view on click of share: