teamsfx-extension

Microsoft Teams Toolkit for Visual Studio Code

What is the Teams Toolkit?

The Teams Toolkit helps developers create and deploy Teams apps with integrated Identity, access to cloud storage, data from Microsoft Graph, and other services in Azure and M365 with a “zero-configuration” approach to the developer experience.

What are Teams app “Capabilities”?

Teams apps are a combination of capabilities and entry points. For example, people can chat with your app's bot (capability) in a channel (entry point).

Tab

Tab are Teams-aware webpages embedded in Microsoft Teams. They are simple HTML tags that point to domains declared in the app manifest and can be added as part of a channel inside a team, group chat, or personal app for an individual user.

Bot

Bots allow users to interact with your web service through text, interactive cards, and task modules.

Messaging Extension

Messaging extensions allow users to interact with your web service through buttons and forms in the Microsoft Teams client.

Build a Teams app in less than 5 minutes

Build a Teams app from the scratch or explore our samples to help you quickly get started with the basic Teams app concepts and code structures.

Prerequisites

Verify you have the right prerequisites for building Teams apps and install some recommended development tools. Read more details.

	Node.js As a fundamental runtime context for Teams app, Node.js v10.x, v12.x or v14.x is required (v14.x is recommended).
	M365 The Teams Toolkit requires a Microsoft 365 organizational account where Teams is running and has been registered.
	Azure The Teams Toolkit may require an Azure account and subscription to deploy the Azure resources for your project.

Don’t have a M365 to experience building Teams app? Sign up for Microsoft Developer Program, which allows you to have a testing tenant with preconfigured permissions.

Getting started

After installing the Teams toolkit, follow the Get Started instruction in our documentation to smoothly start with.

Under the Teams Toolkit extension tab, you can easily discover all applicable commands in the sidebar and Command Palette with the keyword ‘TeamsFx’. It also supports Command Line Interface (CLI) to increase efficiency.

Create your project

Use the Teams Toolkit in Visual Studio Code to set up your first app project. Create your app project using the following steps:

• Ensure you've installed the Microsoft Teams Toolkit
• In Visual Studio Code, open the Command Palette (Ctrl+Shift+P / ⌘⇧-P or View -> Command - Palette) and type teams and choose TeamsFx - Start A New Project.
• Type a name for your project and hit Enter
• Next, Add capabilities comes up. Select capability you want then Next.
• Choose options according to your purpose, i.e., front-end hosting type, language, cloud resources and so on.
• Choose a location where your new application will be created in a new folder.

Configure your app

At its core, the Teams app embraces three components:

• The Microsoft Teams client (web, desktop or mobile) where users interact with your app.

• A server that responds to requests for content that will be displayed in Teams, e.g., HTML tab content or a bot adaptive card .

• A Teams app package consisting of three files:

  ✔️ The manifest.json.

  ✔️ A color icon for your app to display in the public or organization app catalog.

  ✔️ An outline icon for display on the Teams activity bar.

When an app is installed, the Teams client parses the manifest file to determine needed information like the name of your app and the URL where the services are located.

• To configure your app, navigate to the Microsoft Teams Toolkit tab in Visual Studio Code.
• Go to Manifest Editor in the sidebar menu to edit the manifest.json of your Teams app.
• The toolkit will automatically update the app registration data accordingly during app side-loading and publish.

Preview your app on your local/remote dev environment

Prerequisites: Enable Teams developer preview mode

Simply press F5 to run your first Teams or navigate to the Debug tab in the activity bar and select Run icon to display the Run and Debug view. As a default, the toolkit will automatically help you to setup local environment and load the app in Teams.

If you want to have a better estimation of how the app will behave in the cloud environment, you can deploy your resources to the cloud and preview your app with the backend running in the cloud (remote).

Deploy your application to Azure

Deployment happens in two steps: Provisioning and Deployment. Provisioning creates all the necessary Azure resources that your application uses. It is typically done once. To provision your backend to an active Azure subscription:

• In the Visual Studio Code Command Palette, enter the command TeamsFx - Provision Resource.
• You will be asked to sign into your Azure account. This is the account where Azure resources will be provisioned. Typically this is different from the M365 account you used to sign in earlier.
• You will be asked to select a subscription to use from the Azure account.
• Once provisioning is completed, Visual Studio Code will popup the notification with the message "[Teams Toolkit] provision finished successfully".

Deploy copies your application to the provisioned Azure resources. It is typically done after every change to your application. To deploy your application to the provisioned resources in an active Azure subscription:

• In the Visual Studio Code Command Palette, enter the command TeamsFx - Deploy Package.
• Select Tab app and Backend to deploy.
• Once deploy is finished, go to the Visual Studio Code Debug Panel (Ctrl+Shift+D / ⌘⇧-D or View -> Run) and select Launch Remote (Edge).
• Press the start button (green arrow) to launch your app - now running remotely on Azure!

Publish your application to Teams

When your application resources and infrastructure are deployed successfully, you can publish and register your app to Teams app catalog to share with others in your organization.

• In the Visual Studio Code Command Palette, enter the command TeamsFx - Publish to Teams.
• Depending on your permission, you can send your app to the admin portal directly, or manually submit the app package file to your admin to check.
• Once your app is approved by your admin, you can see it under ‘Built for your org’ section in Teams Apps.

Contributing

There are many ways in which you can participate in the project, for example:

• Download our latest builds.
• Submit bugs and feature requests, and help us verify as they are checked in
• Review source code changes
• Review the documentation and make pull requests for anything from typos to new content

Reporting security issues

Give security researchers information on how to privately report security vulnerabilities found in your open source project. See more details Reporting security issues.

Telemetry

The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described in the repository. There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with` applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft's privacy statement. Our privacy statement is located at Microsoft Privacy Statement. You can learn more about data collection and use in the help documentation and our privacy statement. Your use of the software operates as your consent to these practices.

Code of conduct

See Microsoft Open Source code of conduct.

Trademark

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.

License

Copyright (c) Microsoft Corporation. All rights reserved.

Licensed under the MIT license.