sbtron / ToDoApp

How to use this Teams Tab app HelloWorld app

Microsoft Teams supports the ability to run web-based UI inside "custom tabs" that users can install either for just themselves (personal tabs) or within a team or group chat context.

Prerequisites

• Node.js, supported versions: 16, 18
• An M365 account. If you do not have M365 account, apply one from M365 developer program
• Teams Toolkit Visual Studio Code Extension version 5.0.0 and higher or TeamsFx CLI

Debug

• From Visual Studio Code: Start debugging the project by hitting the F5 key in Visual Studio Code.
• Alternatively use the Run and Debug Activity Panel in Visual Studio Code and click the Run and Debug green arrow button.
• From TeamsFx CLI:
  • Executing the command teamsfx provision --env local in your project directory.
  • Executing the command teamsfx deploy --env local in your project directory.
  • Executing the command teamsfx preview --env local in your project directory.

Edit the manifest

You can find the Teams app manifest in ./appPackage folder. The folder contains one manifest file:

• manifest.json: Manifest file for Teams app running locally or running remotely (After deployed to Azure).

This file contains template arguments with ${{...}} statements which will be replaced at build time. You may add any extra properties or permissions you require to this file. See the schema reference for more information.

Deploy to Azure

Deploy your project to Azure by following these steps:

From Visual Studio Code	From TeamsFx CLI
Open Teams Toolkit, and sign into Azure by clicking the Sign in to Azure under the ACCOUNTS section from sidebar. After you signed in, select a subscription under your account. Open the Teams Toolkit and click Provision from DEVELOPMENT section or open the command palette and select: Teams: Provision. Open the Teams Toolkit and click Deploy or open the command palette and select: Teams: Deploy.	Run command teamsfx account login azure. Run command teamsfx provision --env dev. Run command: teamsfx deploy --env dev.

Note: Provisioning and deployment may incur charges to your Azure Subscription.

Preview

Once the provisioning and deployment steps are finished, you can preview your app:

• From Visual Studio Code

  1. Open the Run and Debug Activity Panel.
  2. Select Launch Remote (Edge) or Launch Remote (Chrome) from the launch configuration drop-down.
  3. Press the Play (green arrow) button to launch your app - now running remotely from Azure.

• From TeamsFx CLI: execute teamsfx preview --env dev in your project directory to launch your application.

Validate manifest file

To check that your manifest file is valid:

• From Visual Studio Code: open the command palette and select: Teams: Validate Application.
• From TeamsFx CLI: run command teamsfx validate in your project directory.

Package

• From Visual Studio Code: open the Teams Toolkit and click Zip Teams App Package or open the command palette and select Teams: Zip Teams App Package.
• Alternatively, from the command line run teamsfx package in the project directory.

Publish to Teams

Once deployed, you may want to distribute your application to your organization's internal app store in Teams. Your app will be submitted for admin approval.

• From Visual Studio Code: open the Teams Toolkit and click Publish or open the command palette and select: Teams: Publish.
• From TeamsFx CLI: run command teamsfx publish in your project directory.

Add Single Sign On feature

Microsoft Teams provides a mechanism by which an application can obtain the signed-in Teams user token to access Microsoft Graph (and other APIs). Teams Toolkit facilitates this interaction by abstracting some of the Azure Active Directory (AAD) flows and integrations behind some simple, high-level APIs. This enables you to add single sign-on (SSO) features easily to your Teams application.

Please follow this document to add single sign on for your project.