| title | Create Basic Tab App |
|---|---|
| description | Learn how to build your basic tab app in Microsoft Teams with the help of GitHub codespaces that opens Toolkit extension and step-by-step guides. |
| ms.localizationpriority | high |
| ms.date | 12/11/2024 |
| ms.topic | reference |
Tabs are Teams-aware webpages embedded in Microsoft Teams and a good way to begin developing for Teams. You can add them as part of a channel inside a team, group chat, or personal app for an individual user.
:::image type="content" border="false" source="../assets/images/get-started/get-started-tab.png" alt-text="Screenshot shows you the conceptual tab app in Teams client.":::
In this tutorial, you'll learn:
- How to set up a new project with Microsoft 365 Agents Toolkit (previously known as Teams Toolkit).
- How to build a tab app
- The structure of the app
- The tab portion with JavaScript using React
- The rest of the features with Node.js
- How to deploy your app
This step-by-step guide helps you to build tab with Agents Toolkit. You'll see the following output after you've completed this guide:
:::image type="content" source="../assets/images/toolkit-v2/first-tab/tab-app-localdebug.png" alt-text="Screenshot shows the completed app" lightbox="../assets/images/toolkit-v2/first-tab/tab-app-localdebug-1.png":::
Ensure you install the following tools for building and deploying your apps.
| Install | For using... | |
|---|---|---|
| Required | ||
| Visual Studio Code | JavaScript, TypeScript, or SharePoint Framework (SPFx) build environments. Use the latest version. | |
| Microsoft 365 Agents Toolkit | Microsoft Visual Studio Code extension that creates a project scaffolding for your app. Use the latest version. | |
| Node.js | Back-end JavaScript runtime environment. For more information, see Node.js version compatibility table for project type. | |
| Microsoft Teams | Microsoft Teams to collaborate with everyone you work with through apps for chat, meetings, and call all in one place. | |
| Microsoft Edge (recommended) or Google Chrome | A browser with developer tools. | |
| Optional | ||
| Azure Tools for Visual Studio Code and Azure CLI | Azure tools to access stored data or to deploy a cloud-based backend for your Teams app in Azure. | |
| React Developer Tools for Chrome OR React Developer Tools for Microsoft Edge | A browser DevTools extension for the open-source React JavaScript library. | |
| Microsoft Graph Explorer | Microsoft Graph Explorer, a browser-based tool that lets you run a query from Microsoft Graph data. | |
| Developer Portal for Teams | Web-based portal to configure, manage, and publish your Teams app including to your organization or the Microsoft Teams Store. |
Tip
If you work with Microsoft Graph data, you should learn about and bookmark the Microsoft Graph Explorer. This browser-based tool allows you to query Microsoft Graph outside of an app.
[!INCLUDE Set up prerequisites]
[!div class="nextstepaction"] I ran into an issue
If you want to host your app or access resources in Azure, you must have an Azure subscription. Create a free account before you begin.
Now you've got all the tools to set up your account. Next, let's set up your development environment and start building! Select the app you want to create first.
Start Microsoft Teams app development by creating your first app. This app uses the tab capability.
:::image type="content" source="../assets/images/toolkit-v2/first-tab/your-helloworld-app-tab.png" alt-text="Diagram shows that this app has three features. Tab is highlighted.":::
If the prerequisites are in place, let's begin!
Note
The Visual Studio Code UI shown is from Mac. Agents Toolkit version and environment might differ based on your operating system.
-
Open Visual Studio Code.
-
Select the Microsoft 365 Agents Toolkit :::image type="icon" source="../assets/images/toolkit-v2/toolkit-sidebar-icon.png"::: icon in the Visual Studio Code Activity Bar.
-
Select Create a New Agent/App > Teams App.
:::image type="content" source="../assets/images/toolkit-v2/first-tab/create-project.png" alt-text="Screenshots shows the location of the Create New Project link in the Teams Toolkit sidebar.":::
-
Select Other Teams Capabilities
:::image type="content" source="../assets/images/toolkit-v2/first-tab/other-teams-capabilities.png" alt-text="Screenshot shows the Other Teams Capabilities to select.":::
-
In this example, select Tab as app capability.
:::image type="content" source="../assets/images/toolkit-v2/first-tab/select-capabilities-tabapp.png" alt-text="Screenshot shows the App Capability to select.":::
-
Select Default folder to store your project root folder in default location.
:::image type="content" source="../assets/images/toolkit-v2/first-tab/select-default-location.png" alt-text="Screenshot shows how to select default location.":::
Follow the steps to change the default location:
-
Select Browse.
:::image type="content" source="../assets/images/toolkit-v2/first-tab/select-browse.png" alt-text="Screenshot shows to select browse for storage.":::
-
Select the location for project workspace.
-
Select the Select folder.
:::image type="content" source="../assets/images/toolkit-v2/select-folder.png" alt-text="Screenshot shows how to select-folder.":::
-
Enter a suitable name for your app and then select Enter.
:::image type="content" source="../assets/images/toolkit-v2/first-tab/enter-name-tab1.png" alt-text="Screenshot shows where to enter the app name.":::
The Teams tab app is created in few seconds.
:::image type="content" source="../assets/images/toolkit-v2/first-tab/tap-app-created1.png" alt-text="Screenshot shows the app created.":::
After your app is created, Agents Toolkit displays the following message:
:::image type="content" source="../assets/images/toolkit-v2/preview-project-tab.png" alt-text="Screenshot shows to preview project.":::
You can select Local debug to preview your project.
A quick recap of creating a Teams app.
Watch this short recap for creating a Teams app.
[!div class="nextstepaction"] I ran into an issue
Use the `atk' CLI to create your first project. Start from the folder where you want to create the project folder.
atk newYou can use the CLI to create a new Teams app. The CLI leads you through a series of questions. Every question includes an instruction on answering it. For example, use arrow keys to select an option and then, select Enter to confirm.
- Select Create a new Teams app.
- Select the Tab capability.
- Select Azure frontend hosting.
- Don't select any cloud resources.
- Select JavaScript as the programming language.
- Press Enter to select the default workspace folder.
- Enter
helloworldas the name for your app. The name of the app must have only alphanumeric characters.
After you've answered all the questions, your project is created.
[!div class="nextstepaction"] I ran into an issue
Agents Toolkit provides all components for building an app. After creating the project, you can view the project folders and files in the EXPLORER in the Visual Studio Code.
:::image type="content" source="../assets/images/toolkit-v2/first-tab/folder-structure-tab-app.png" alt-text="Screen shot shows the structure tab.":::
Although you're free to choose any UI framework (or not to use any), this sample template code provides a scaffolding with React components.
Among other items in this directory structure, the Toolkit maintains:
| Folder | Contents |
|---|---|
.vscode |
VSCode files for debugging |
appPackage |
Templates for the application manifest |
env |
Environment files |
infra |
Templates for provisioning Azure resources |
src |
The source code for the application |
The following files can be customized and demonstrate an example implementation to get you started.
| File | Contents |
|---|---|
index.html |
HTML file. |
src/Tab/App.css |
CSS file for the app. |
src/Tab/App.tsx |
Tab source file. It calls teamsjs SDK to get the context of on which Microsoft 365 application your app is running. |
src/index.ts |
Starting the app using Microsoft Teams SDK. |
vite.config.js |
Configuration for Vite build tool. |
nodemon.json |
Configuration for Nodemon to watch and restart the server. |
The following are Microsoft 365 Agents Toolkit specific project files. You can visit a complete guide on Github to understand how Microsoft 365 Agents Toolkit works.
| File | Contents |
|---|---|
m365agents.yml |
This is the main Microsoft 365 Agents Toolkit project file. The project file defines two primary things: Properties and configuration Stage definitions. |
m365agents.local.yml |
This overrides m365agents.yml with actions that enable local execution and debugging. |
After you set up your project workspace with Agents Toolkit, build your tab project. You need to sign in to your Microsoft 365 account.
Use your Microsoft 365 account to sign in to Teams. If you're using a Microsoft 365 developer program tenant, the admin account you set up while registering is your Microsoft 365 account.
- Open Visual Studio Code.
- Select the Microsoft 365 Agents Toolkit :::image type="icon" source="../assets/images/toolkit-v2/toolkit-sidebar-icon.png"::: icon in the sidebar.
- Select Sign in to M365 using your credentials. Your default web browser opens to let you sign in to the account.
- Close the browser when prompted and return to Visual Studio Code.
- Return to Agents Toolkit within Visual Studio Code.
The ACCOUNTS section of the sidebar shows your Microsoft 365 account name. If custom app upload is enabled for your Microsoft 365 account, Agents Toolkit displays Custom App Upload Enabled.
:::image type="content" source="../assets/images/toolkit-v2/first-tab/m365-uploading-enabled.png" alt-text="Screenshot showing where to sign in to Microsoft 365 and Azure.":::
Now you're ready to build the app and run it in the local environment!
[!div class="nextstepaction"] I ran into an issue
- Sign in to Microsoft 365 with Microsoft 365 Agents Toolkit CLI (previously known as TeamsFx CLI):
atk account login m365Your default web browser opens to let you sign in to the account. Sign in to your Azure account using your credentials. Close the browser when you're prompted.
- Sign in to Azure with Agents Toolkit CLI:
atk account login azureYour default web browser opens to let you sign in to the account. Sign in to your Azure account using your credentials. Close the browser when you're prompted.
The account logins are shared between Visual Studio Code and Agents Toolkit CLI.
Now that the development environment is configured, you. can create, build, and deploy your first Teams app.
[!div class="nextstepaction"] I ran into an issue
To build and run your app locally:
From Visual Studio Code, select F5 to run the application in debug mode.
Learn what happens when you run your app locally in the debugger.
In case you're wondering, when you press the F5 key, Agents Toolkit:
- Checks for the following prerequisites:
- You're logged in with a Microsoft 365 account.
- Custom app upload is enabled for your Microsoft 365 account.
- Supported Node.js version is installed.
- Development certificate for localhost is installed.
- Port is available for the tab app.
[!NOTE] If Agents Toolkit is unable to check a particular prerequisite, it prompts you to check.
- Installs NPM packages.
- Registers the app with Microsoft Entra ID and configures the app.
- Registers the app in Teams Developer Portal and configures the app.
- Starts the tab app.
- Starts Teams in a web browser and uploads the tab app.
:::image type="content" source="../assets/images/toolkit-v2/first-tab/f5-build-and-run.png" alt-text="Screenshot showing when F5 key is pressed." lightbox="../assets/images/toolkit-v2/first-tab/f5-build-and-run.png":::
Note
When you run the app for the first time, all dependencies are downloaded, and the app is built. A browser window opens when the build is complete. This process can take 3-5 minutes to complete.
The toolkit prompts you to install a local certificate, if necessary. This certificate allows Teams to load your application from https://localhost.
Select Yes if the following dialog appears:
:::image type="content" source="../assets/images/toolkit-v2/first-tab/hw-warning.png" alt-text="Screenshot shows the microsoft warning.":::
Or select Continue, depending on your operating system:
:::image type="content" source="../assets/images/toolkit-v2/first-tab/ssl-prompt-mac.png" alt-text="Screenshot showing the prompt to install an SSL certificate to enable Teams to load your application from localhost on Mac.":::
Teams web client opens in a browser window.
Note
If the toolkit doesn't prompt you to install a certificate, you must install the certificate manually. For more information, see Add manual certificate.
- Sign in with your Microsoft 365 account, if prompted.
- Select Add when prompted to upload the custom app onto Teams on your local machine.
:::image type="content" source="../assets/images/toolkit-v2/first-tab/add-tab-app-local-debug.png" alt-text="Screenshot shows to add the app to Teams.":::
- Congratulations, your first app is running on Teams!
:::image type="content" source="../assets/images/toolkit-v2/first-tab/tab-app-localdebug.png" alt-text="Screenshot shows the completed app" lightbox="../assets/images/toolkit-v2/first-tab/tab-app-localdebug-1.png":::
Note
If you want to extend your app to Outlook and Microsoft 365, you can choose to debug your app with Outlook and Microsoft 365 from RUN AND DEBUG dropdown in Visual Studio Code.
You can add SSO feature to retrieve the user details. You can do normal debugging activities, such as setting breakpoints, as if it were any other web application. The app supports hot reloading. If you change any file within the project, the page reloads.
[!div class="nextstepaction"] I ran into an issue
Learn how to troubleshoot if your app doesn't run locally.
To successfully run your app in Teams, ensure that you've enabled custom app upload in your Teams account. You can learn more about custom app upload in the prerequisites section.
You've learned to create, build, and run Teams app with Tab app. The final step is to deploy your app on Azure.
Let's deploy the first app with Tab capability on Azure using Agents Toolkit.
Use this account to access the Microsoft Azure portal and to provision new cloud resources to support your app.
- Open Visual Studio Code.
- Open the project folder in which you created the tab app.
- Select the Microsoft 365 Agents Toolkit :::image type="icon" source="../assets/images/toolkit-v2/toolkit-sidebar-icon.png"::: icon in the sidebar.
- Select Sign in to Azure using your credentials.
Tip
If you have the AZURE ACCOUNT extension installed and are using the same account, you can skip this step. Use the same account as you're using in other extensions.
Your default web browser opens to let you sign in to the account.
- Close the browser when prompted and return to Visual Studio Code.
The ACCOUNTS section of the sidebar shows the two accounts separately. It also lists the number of usable Azure subscriptions available to you. Ensure you have at least one usable Azure subscription available. If not, sign out and use a different account.
Congratulations, you've created a Teams app! Now let's go ahead and learn how to deploy one of the apps to Azure using Agents Toolkit.
[!div class="nextstepaction"] I ran into an issue
- Sign in to Microsoft 365 with Agents Toolkit CLI:
atk account login m365Your default web browser opens to let you sign in to the account. Sign in to your Azure account using your credentials. Close the browser when you're prompted.
- Sign in to Azure with Agents Toolkit CLI:
atk account login azureYour default web browser opens to let you sign in to the account. Sign in to your Azure account using your credentials. Close the browser when you're prompted.
The account logins are shared between Visual Studio Code and Agents Toolkit CLI.
Congratulations, you've created a Teams app! Now let's go ahead and learn how to deploy one of the apps to Azure using Agents Toolkit.
[!div class="nextstepaction"] I ran into an issue
[!INCLUDE Provision and Deploy your app on Azure]
[!div class="nextstepaction"] I ran into an issue
Learn what happens when you deployed your app to Azure
Before deployment, the application has been running locally:
- The backend runs using Azure Functions Core Tools.
- The application HTTP endpoint, where Microsoft Teams loads the application, runs locally.
Deployment is a two-step process. You provision the resources on an active Azure subscription, and then deploy or upload the backend and frontend code for the application to Azure.
- The backend, if configured, uses various Azure services, including Azure App Service and Azure Storage.
- The frontend application is deployed to an Azure Storage account configured for static web hosting.
You've done it!
You've created a tab app.
Now that you've learned to create a basic app, you can move on to creating more complex apps. Follow the procedures to build and deploy the app, and your app has multiple capabilities.
You've completed the tutorial to build tab app with JavaScript.