Skip to content

Teams Toolkit for Codespaces

Dooriya Li edited this page Mar 9, 2023 · 20 revisions

Using Teams Toolkit for App Development in Codespaces

Introduction

GitHub Codespaces is a cloud-based development environment for your GitHub projects that allows developers to develop and collaborate on code from anywhere, using a web browser or Visual Studio Code. With GitHub Codespaces, Teams Toolkit provides new "install-less" getting started experience for Teams app development, so you can quickly get started with a fully configured dev environment without spending time on local environment setup.

Prerequisites

Before getting started building Teams app with Codespaces, please make sure:

  1. You have a GitHub account which will be used to create a Codespaces instance.
  2. You have a M365 Account with sideloading permissions. You may find the setup instructions in the Prepare your Microsoft 365 tenant. If you don’t already have a Microsoft 365 account, you can register for a free one through the Microsoft 365 Developer Program.

Getting started from codespaces-enabled sample

Sample name Entry point
Hello World Tab Open hello-world tab in GitHub Codespaces
Notification Bot Open notification app in GitHub Codespaces
NPM Search Message Extension Coming soon!

Enable Codespaces for Teams app

Besides getting started from our codespaces-enabled samples, you can enable codespaces configuration for your TeamsFx projects on GitHub by following the steps below:

  1. Add a dev container configuration
  2. Update .vscode/tasks.json
  3. Update .vscode/launch.json
  4. Update teamsapp.local.yml
  5. Commit all the above code changes to your project repository
Clone this wiki locally