This app template is a search-based message extension that allows users to search an external system and share results through the compose message area of the Microsoft Teams client. You can now build and run your search-based message extensions in Teams, Outlook for Windows desktop and web experiences.
Prerequisites
To run the template in your local dev machine, you will need:
- Node.js, supported versions: 16, 18
- Teams Toolkit Visual Studio Code Extension version 5.0.0 and higher or Teams Toolkit CLI
For local debugging using Teams Toolkit CLI, you need to do some extra steps described in Set up your Teams Toolkit CLI for local debugging.
- First, select the Teams Toolkit icon on the left in the VS Code toolbar.
- Press F5 to start debugging which launches your app in Teams App Test Tool using a web browser. Select
Debug in Test Tool. - To trigger the Message Extension, you can click the
+in compose message area and selectSearch Command
Congratulations! You are running an application that can now search npm registries in Teams App Test Tool.
| Folder | Contents |
|---|---|
.vscode/ |
VSCode files for debugging |
appPackage/ |
Templates for the Teams application manifest |
env/ |
Environment files |
infra/ |
Templates for provisioning Azure resources |
src/ |
The source code for the search application |
The following files can be customized and demonstrate an example implementation to get you started.
| File | Contents |
|---|---|
src/searchApp.js |
Handles the business logic for this app template to query npm registry and return result list. |
src/index.js |
index.js is used to setup and configure the Message Extension. |
The following are Teams Toolkit specific project files. You can visit a complete guide on Github to understand how Teams Toolkit works.
| File | Contents |
|---|---|
teamsapp.yml |
This is the main Teams Toolkit project file. The project file defines two primary things: Properties and configuration Stage definitions. |
teamsapp.local.yml |
This overrides teamsapp.yml with actions that enable local execution and debugging. |
teamsapp.testtool.yml |
This overrides teamsapp.yml with actions that enable local execution and debugging in Teams App Test Tool. |
Following documentation will help you to extend the template.
- Add or manage the environment
- Create multi-capability app
- Add single sign on to your app
- Access data in Microsoft Graph
- Use an existing Microsoft Entra application
- Customize the Teams app manifest
- Host your app in Azure by provision cloud resources and deploy the code to cloud
- Collaborate on app development
- Set up the CI/CD pipeline
- Publish the app to your organization or the Microsoft Teams app store
- Develop with Teams Toolkit CLI
- Preview the app on mobile clients