Skip to content

Latest commit

 

History

History
 
 

nodejs

README.md

page_type products languages title description extensions urlFragment
sample
office-365
javascript
Microsoft Teams NodeJS Helloworld Sample
Microsoft Teams hello world sample app in Node.js
contentType createdDate
samples
10/19/2022 10:02:21 PM
officedev-microsoft-teams-samples-app-hello-world-nodejs

Microsoft Teams hello world sample app.

  • Microsoft Teams hello world sample app.

Interaction with app

HelloWorldGif

Prerequisites

  • Microsoft Teams is installed and you have an account (not a guest account)

  • To test locally, NodeJS must be installed on your development machine (version 16.14.2 or higher)

  • ngrok or equivalent tunneling solution

  • M365 developer account or access to a Teams account with the appropriate permissions to install an app.

Setup

Note these instructions are for running the sample on your local machine, the tunnelling solution is required because the Teams service needs to call into the bot.

1. Setup for Bot

  • In Azure portal, create a Azure Bot resource

  • Ensure that you've enabled the Teams Channel

  • While registering the bot, use https://<your_ngrok_url>/api/messages as the messaging endpoint.

    NOTE: When you create your bot you will create an App ID and App password - make sure you keep these for later.

2. Setup NGROK

  1. Run ngrok - point to port 3333

    ngrok http -host-header=rewrite 3333

3. Setup for code

  1. Clone the repository

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

  2. In a terminal, navigate to samples/app-hello-world/nodejs

  3. Install modules

    npm install

  4. Update the custom-environment-variables configuration for the bot to use the MicrosoftAppId and MicrosoftAppPassword, BaseUrl with application base url.

  5. Update the default configuration for the bot to use the appId and appPassword.

  6. Run your app

    npm start

4. Setup Manifest for Teams

  • This step is specific to Teams.

    • Edit the manifest.json contained in the app-hello-world/nodejs/appPackage folder to replace your Microsoft App Id (that was created when you registered your bot earlier) everywhere you see the place holder string <<Your Microsoft App Id>> (depending on the scenario the Microsoft App Id may occur multiple times in the manifest.json)
    • Edit the manifest.json for configurationUrl inside configurableTabs . Replace <yourNgrok.ngrok.io> with base Url domain. E.g. if you are using ngrok it would be https://1234.ngrok.io then your domain-name will be 1234.ngrok.io.
    • Edit the manifest.json for validDomains with base Url domain. E.g. if you are using ngrok it would be https://1234.ngrok.io then your domain-name will be 1234.ngrok.io.

    Note: If you want to test your app across multi hub like: Outlook/Office.com, please update the manifest.json in the app-hello-world/nodejs/Manifest_Hub folder with the required values.

    • Zip up the contents of the app-hello-world/nodejs/appPackage folder to create a manifest.zip or app-hello-world/nodejs/Manifest_hub folder into a Manifest_Hub.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 Teams Apps/Manage your apps click "Upload an app". Browse to and Open the .zip file. At the next dialog, click the Add button.)
    • Add the app to personal/team/groupChat scope (Supported scopes)

Running the sample

Install App:

InstallApp

Welcome UI:

HelloWorld

Outlook on the web

  • To view your app in Outlook on the web.

  • Go to Outlook on the weband sign in using your dev tenant account.

On the side bar, select More Apps. Your sideloaded app title appears among your installed apps

InstallOutlook

Select your app icon to launch and preview your app running in Outlook on the web

AppOutlook

Note: Similarly, you can test your application in the Outlook desktop app as well.

Office on the web

  • To preview your app running in Office on the web.

  • Log into office.com with test tenant credentials

Select the Apps icon on the side bar. Your sideloaded app title appears among your installed apps

InstallOffice

Select your app icon to launch your app in Office on the web

AppOffice

Note: Similarly, you can test your application in the Office 365 desktop app as well.

Deploy the bot to Azure

To learn more about deploying a bot to Azure, see Deploy your bot to Azure for a complete list of deployment instructions.

Further reading