/bottest

Primary LanguageTypeScript

Overview of the Basic Bot template

Examples of Microsoft Teams bots in everyday use include:

  • Bots that notify about build failures.
  • Bots that provide information about the weather or bus schedules.
  • Bots that provide travel information.

A bot interaction can be a quick question and answer, or it can be a complex conversation. Being a cloud application, a bot can provide valuable and secure access to cloud services and corporate resources.

Get started with the Basic Bot template

Prerequisites

To run the Basic Bot template in your local dev machine, you will need:

  1. First, select the Teams Toolkit icon on the left in the VS Code toolbar.
  2. In the Account section, sign in with your Microsoft 365 account if you haven't already.
  3. Press F5 to start debugging which launches your app in Teams using a web browser. Select Debug in Teams (Edge) or Debug in Teams (Chrome).
  4. When Teams launches in the browser, select the Add button in the dialog to install your app to Teams.
  5. You will receive a welcome message from the bot, and you can send anything to the bot to get an echoed response.

Congratulations! You are running an application that can now interact with users in Teams:

basic bot

What's included in the template

Folder Contents
.vscode VSCode files for debugging
appPackage Templates for the Teams application manifest
env Environment files
infra Templates for provisioning Azure resources

The following files can be customized and demonstrate an example implementation to get you started.

File Contents
teamsBot.ts Handles business logics for the Basic Bot.
index.ts index.ts is used to setup and configure the Basic Bot.

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.

Extend the Basic Bot template

Following documentation will help you to extend the Basic Bot template.