Navigation
- 00.OVERVIEW
- Bot Framework Emulator
- Manual resource setup
- Teams Toolkit extra information
- Teams Toolkit CLI
If you already have uploaded a custom app to a desktop client using the
/appPackage/appPackage.local.zip
file available from the samples, you can skip the first 2 steps.
-
Create Bot Framework registration resource in Azure
-
Enable the Teams Channel in Azure
-
In a terminal, navigate to
teams-ai/js/samples/<sample-foldername-here>
#if you have not built the project yet, run: cd teams-ai/js yarn && yarn build # this only needs to be done once after clone or pull cd teams-ai/js/samples/<sample-foldername-here>
-
Update the
.env
configuration for the bot to use the Microsoft App Id and App Password from the Bot Framework registration. (Note the App Password is referred to as the "client secret" in the Azure Portal and you can always create a new client secret anytime.) -
Run ngrok tunneling service - point to port 3978
ngrok http --host-header=rewrite 3978
- Use the current
https
URL you were given by running ngrok. Append with the path/api/messages
used by this sample.
- Use the current
Note: The following is specific to Teams. If you are using a different channel, you do not need to upload a manifest
-
Verify your app manifest has all RSC permissions needed to perform its tasks. (If you are using the Teams Toolkit, this is done for you.)
- Optionally use App Studio to verify your manifest has the correct permissions.
-
Edit the
manifest.json
contained in theappPackage
folder to replace your Microsoft App Id (that was created when you registered your bot earlier) everywhere you see the place holder string${{TEAMS_APP_ID}}
- (depending on the scenario the Microsoft App Id may occur multiple times in the
manifest.json
). - If you haven't created an Azure app service yet, you can use your bot id for the above.
- Your bot id should be pasted in where you see
${{BOT_ID}}
andMicrosoftAppId
. ${{BOT_PASSWORD}}
andMicrosoftAppPassword
is where you should add the client secret.- Replace everywhere you see
${{BOT_DOMAIN}}
with the domain part of the URL created by your tunneling solution. - Zip up the contents of the
appPackage
folder to create amanifest.zip
- (depending on the scenario the Microsoft App Id may occur multiple times in the
-
Run your app from the command line:
yarn start
-
In Teams, upload the app file (manifest.zip created in the previous step) and install the app to test.