Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Edit hello world section and add more images #2907

Merged
merged 131 commits into from Apr 28, 2021
Merged
Show file tree
Hide file tree
Changes from 121 commits
Commits
Show all changes
131 commits
Select commit Hold shift + click to select a range
4a38081
Update build-first-app-overview.md
girliemac Mar 11, 2021
8a5859d
Edit hello world section and add more images
girliemac Mar 12, 2021
5920b39
Fix broken links
girliemac Mar 12, 2021
f3934a5
Fix link and remove .DS_Store
girliemac Mar 12, 2021
641c808
Fix broken links
girliemac Mar 12, 2021
19fa784
Add files via upload
girliemac Mar 12, 2021
d627b4e
Edit image
girliemac Mar 15, 2021
24108f0
Edit images
girliemac Mar 15, 2021
1fd548b
Edit Personal Tab tutorial
girliemac Mar 15, 2021
bd51330
Update with Yaomen generator mention
girliemac Mar 16, 2021
9387984
Edit dev tenant section
girliemac Mar 16, 2021
871893f
Updated build-and-run.md
v-vrajaraman Mar 18, 2021
5b885c2
Updated images
v-vrajaraman Mar 18, 2021
02f26de
Add Troubleshooting section
girliemac Mar 18, 2021
3e52178
Update build-first-app-overview.md
girliemac Mar 18, 2021
4a01ca9
Updated Troubleshooting Section
v-vrajaraman Mar 19, 2021
a93f94b
Updated document to fix the broken links
v-vrajaraman Mar 22, 2021
a501393
Updated build-bot.md
v-vrajaraman Mar 22, 2021
753dbae
Updated Build-messagingextentions.md
v-vrajaraman Mar 22, 2021
21f7143
Updated build-messaging-extension.md
v-vrajaraman Mar 22, 2021
9bc23b0
Minor fix
girliemac Mar 22, 2021
5803111
Edit for Toolkit v1.2
girliemac Mar 22, 2021
b5c20b3
Updated image file
KirtiPereira Mar 10, 2021
46139de
Update removing-tab-margins.md
KirtiPereira Mar 10, 2021
a35e2c3
Update deep-links.md
KirtiPereira Mar 11, 2021
9eba0b1
Update deep-links.md
KirtiPereira Mar 12, 2021
c2c1fe6
Update whats-new.md
KirtiPereira Mar 12, 2021
bd2861f
Edit hello world section and add more images
girliemac Mar 12, 2021
18b3a7f
Fix broken links
girliemac Mar 12, 2021
f5f516e
Fix link and remove .DS_Store
girliemac Mar 12, 2021
50f5e48
Edit image
girliemac Mar 15, 2021
9bb836c
Edit images
girliemac Mar 15, 2021
2092bdd
Edit Personal Tab tutorial
girliemac Mar 15, 2021
7c9bc8e
Updated build-and-run.md
v-vrajaraman Mar 18, 2021
f68659b
Updated images
v-vrajaraman Mar 18, 2021
595dc1d
Add Troubleshooting section
girliemac Mar 18, 2021
d7fc0b7
Updated Troubleshooting Section
v-vrajaraman Mar 19, 2021
a31a27f
Updated document to fix the broken links
v-vrajaraman Mar 22, 2021
19c0322
Updated build-bot.md
v-vrajaraman Mar 22, 2021
6ed3942
Updated Build-messagingextentions.md
v-vrajaraman Mar 22, 2021
37af9bf
Updated build-messaging-extension.md
v-vrajaraman Mar 22, 2021
a40b68a
Minor fix
girliemac Mar 22, 2021
deb6042
Edit for Toolkit v1.2
girliemac Mar 22, 2021
7af6642
merge
girliemac Mar 22, 2021
c249df0
Updated Build-channel-tab
v-vrajaraman Mar 25, 2021
0f6a40f
Updated all files in 2907
v-vrajaraman Mar 30, 2021
99c4b9b
Edit images
girliemac Mar 31, 2021
3cc0a4c
Fix image links
girliemac Mar 31, 2021
b6c6be5
Updated bookmark in line 18
v-vrajaraman Mar 31, 2021
39be3bc
Fixed bookmark in line 31
v-vrajaraman Mar 31, 2021
e2b62bc
Bookmark fixed in line 29
v-vrajaraman Mar 31, 2021
347cc97
Fixed broken bookmarks
v-vrajaraman Mar 31, 2021
9858b51
Merge branch 'hello-world' of https://github.com/MicrosoftDocs/msteam…
v-vrajaraman Mar 31, 2021
d547fee
Fixed broken bookmark
v-vrajaraman Mar 31, 2021
1583e10
Fixed broken bookmarks
v-vrajaraman Mar 31, 2021
74df033
Update build-first-app-overview.md
KirtiPereira Mar 31, 2021
8320967
Updated build-first-app-overview.md
v-vrajaraman Apr 1, 2021
899be24
Updated overview to embed video file
v-vrajaraman Apr 1, 2021
3c0e6f5
Updated Overview for Style changes.
v-vrajaraman Apr 1, 2021
a81b879
Images alignment fixed
v-vrajaraman Apr 1, 2021
079ae87
Added Additional Resources Section
v-vrajaraman Apr 1, 2021
1cc7f6e
Updated overview.md
v-vrajaraman Apr 1, 2021
819a728
Update build-first-app-overview.md
v-vrajaraman Apr 1, 2021
3de23a4
Update build-first-app-overview.md
v-vrajaraman Apr 1, 2021
7285caf
Changed Additional Resources to See Also
v-vrajaraman Apr 1, 2021
c6238f4
Updated build and run file with Surabhi's comments
v-vrajaraman Apr 1, 2021
52ea5d5
Updated build and run
v-vrajaraman Apr 1, 2021
fa63d20
Updated build-personal-tab.md
v-vrajaraman Apr 5, 2021
1edc989
Updated build-channel-tab
v-vrajaraman Apr 5, 2021
0be127a
Updated overview and build and run
v-vrajaraman Apr 6, 2021
9a24cfa
Updated build-and-run for style changes
v-vrajaraman Apr 6, 2021
617c35e
Fixed toggle button and style issues
v-vrajaraman Apr 7, 2021
be84f17
Fixed toggle
v-vrajaraman Apr 7, 2021
fd047cd
fixed toggle
v-vrajaraman Apr 7, 2021
d9a4f28
Updated personal tab for style issues
v-vrajaraman Apr 7, 2021
0e24923
Updated Personal tab
v-vrajaraman Apr 7, 2021
13a9cde
Updated Get started files
v-vrajaraman Apr 7, 2021
93c4e05
Updated for text alignment
v-vrajaraman Apr 7, 2021
e42a2ef
Numbering corrected
v-vrajaraman Apr 7, 2021
32cc9da
Corrected style errors
v-vrajaraman Apr 7, 2021
267639f
Corrected style issues
v-vrajaraman Apr 7, 2021
441c9e8
Updated build-channel-tab
v-vrajaraman Apr 7, 2021
4304954
Updated build-messaging-extentions
v-vrajaraman Apr 7, 2021
2484bfa
Included Tomomi's comment for build and run and included some style c…
v-vrajaraman Apr 9, 2021
474a816
Style and spacing issues fixed
v-vrajaraman Apr 9, 2021
2b12daa
Updated for Issues 3018, 3019, and 3094
v-vrajaraman Apr 12, 2021
c4d274b
updated build-and-run
v-vrajaraman Apr 12, 2021
20329f1
Merge branch 'master' into hello-world
v-vrajaraman Apr 12, 2021
8c24595
Merged #2924 to #2907
v-vrajaraman Apr 12, 2021
8065333
Style updates
v-vrajaraman Apr 12, 2021
43730d5
broken links fixed
v-vrajaraman Apr 12, 2021
626c12d
Fixed broken links
v-vrajaraman Apr 12, 2021
835f21f
Fix #3019
girliemac Apr 14, 2021
0c63684
Add bot tutorial images
girliemac Apr 14, 2021
042b02a
Add more bot tutorial image
girliemac Apr 14, 2021
e20796a
Fix a broken image path
girliemac Apr 14, 2021
2179807
Replace a screenshot
girliemac Apr 14, 2021
5b69e96
Validation errors fixed
v-vrajaraman Apr 16, 2021
0da177f
self review updates
v-vrajaraman Apr 16, 2021
977ad16
Merge branch 'master' into hello-world
v-vrajaraman Apr 16, 2021
61c9b44
Self-Review sanity updates
v-vrajaraman Apr 21, 2021
318a080
Sanity check done
v-vrajaraman Apr 21, 2021
a6d5673
Updated file for self review
v-vrajaraman Apr 21, 2021
0538f70
Fixed comments
v-vrajaraman Apr 21, 2021
b13521d
Sanity check
v-vrajaraman Apr 21, 2021
98682db
sanity check updates
v-vrajaraman Apr 22, 2021
bd32346
link fixed
v-vrajaraman Apr 22, 2021
a344253
Update msteams-platform/build-your-first-app/build-and-run.md
v-vrajaraman Apr 26, 2021
1b00c61
Merge branch 'master' into hello-world
v-vrajaraman Apr 26, 2021
618309d
Fixed review comments and fixed issue #3020
v-vrajaraman Apr 26, 2021
a3ae880
Merge branch 'hello-world' of https://github.com/MicrosoftDocs/msteam…
v-vrajaraman Apr 26, 2021
597e496
Fixed broken links
v-vrajaraman Apr 26, 2021
8360f0b
Fixed broken link
v-vrajaraman Apr 26, 2021
337c954
Fixed links
v-vrajaraman Apr 26, 2021
4aa2544
Fixed links
v-vrajaraman Apr 26, 2021
f5820fa
sanity check
v-vrajaraman Apr 26, 2021
e5bb0a2
Sanity check
v-vrajaraman Apr 26, 2021
030743f
Link fixed
v-vrajaraman Apr 26, 2021
71ed04a
Link fixed
v-vrajaraman Apr 26, 2021
a71eacc
Update msteams-platform/build-your-first-app/build-first-app-overview.md
heath-hamilton Apr 26, 2021
3825766
Update msteams-platform/build-your-first-app/build-first-app-overview.md
heath-hamilton Apr 26, 2021
55f9089
Update msteams-platform/build-your-first-app/build-and-run.md
heath-hamilton Apr 26, 2021
1d9f1bb
Fixed Heath's comments
v-vrajaraman Apr 27, 2021
72849a2
Merge branch 'hello-world' of https://github.com/MicrosoftDocs/msteam…
v-vrajaraman Apr 27, 2021
25c2038
Update msteams-platform/build-your-first-app/build-first-app-overview.md
heath-hamilton Apr 27, 2021
0fd050a
Update msteams-platform/build-your-first-app/build-and-run.md
heath-hamilton Apr 27, 2021
c69b919
Update msteams-platform/build-your-first-app/build-and-run.md
heath-hamilton Apr 27, 2021
09e4581
Update msteams-platform/build-your-first-app/build-and-run.md
heath-hamilton Apr 27, 2021
bc3adbd
Update msteams-platform/build-your-first-app/build-first-app-overview.md
heath-hamilton Apr 27, 2021
f5c0571
Update msteams-platform/build-your-first-app/build-first-app-overview.md
heath-hamilton Apr 27, 2021
e36c63f
Added link to Tunnel using ngrok
v-vrajaraman Apr 28, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 5 additions & 5 deletions msteams-platform/TOC.yml
Expand Up @@ -8,17 +8,17 @@
- name: Get started
expanded: true
items:
- name: Overview and prerequisites
- name: Overview
href: build-your-first-app/build-first-app-overview.md
- name: Create a "Hello, World!" app
v-vrajaraman marked this conversation as resolved.
Show resolved Hide resolved
href: build-your-first-app/build-and-run.md
- name: Create a personal tab
- name: Build a basic personal tab for Microsoft Teams
v-vrajaraman marked this conversation as resolved.
Show resolved Hide resolved
href: build-your-first-app/build-personal-tab.md
- name: Create a channel and group tab
- name: Build your first channel and group tab for Microsoft Teams
v-vrajaraman marked this conversation as resolved.
Show resolved Hide resolved
href: build-your-first-app/build-channel-tab.md
- name: Create a bot
- name: Create your first bot for Microsoft Teams
v-vrajaraman marked this conversation as resolved.
Show resolved Hide resolved
href: build-your-first-app/build-bot.md
- name: Create a messaging extension
- name: Build your first messaging extension for Microsoft Teams
v-vrajaraman marked this conversation as resolved.
Show resolved Hide resolved
href: build-your-first-app/build-messaging-extension.md
- name: Tutorials and code samples
items:
Expand Down
Binary file modified msteams-platform/assets/icons/vsc-toolkit.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
208 changes: 162 additions & 46 deletions msteams-platform/build-your-first-app/build-and-run.md
@@ -1,81 +1,197 @@
---
title: Get started - Build and run your first app
author: heath-hamilton
author: girliemac
description: Quickly create a Microsoft Teams app that displays a "Hello, World!" message using the Microsoft Teams Toolkit.
ms.author: lajanuar
localization_priority: Normal
ms.date: 11/03/2020
ms.author: timura
ms.date: 03/22/2021
ms.topic: quickstart
---
# Build and run your first Microsoft Teams app
# Create your first Microsoft Teams app

Start Microsoft Teams development by building a personal tab that displays "Hello, World!".
Build and run your first Teams app using the following steps:
This quickstart teaches you to build and run Microsoft Teams app that displays "Hello, World!".
v-vrajaraman marked this conversation as resolved.
Show resolved Hide resolved

## Prerequisites

Before you begin, you need to [set up your Teams development tenant](#set-up-your-teams-development-tenant) and [install your Teams development tools](#install-your-development-tools).

### Set up your Teams development tenant

A **tenant** is like a container for an organization. In Teams terms, a tenant is where people from that org chat, share files, and run meetings. As a developer, you need a tenant to sideload and test the apps that you are building.
v-vrajaraman marked this conversation as resolved.
Show resolved Hide resolved

# [Do not have a tenant](#tab/do-not-have-a-tenant)

You can get a free Teams test account, which includes a tenant that allows app sideloading, by joining the Microsoft 365 developer program. The registration process takes approximately two minutes.

**To get a tenant**

1. 1. Go to the [Microsoft 365 developer program](https://developer.microsoft.com/microsoft-365/dev-program).
v-vrajaraman marked this conversation as resolved.
Show resolved Hide resolved
1. Select **Join Now** and follow the onscreen instructions.
1. In the Welcome screen, select **Set up E5 subscription**.
1. Set up your administrator account.
heath-hamilton marked this conversation as resolved.
Show resolved Hide resolved
After you finish, the following screen appears:
v-vrajaraman marked this conversation as resolved.
Show resolved Hide resolved

:::image type="content" source="../assets/images/build-your-first-app/dev-program-subscription.png" alt-text="Example of what you see after signing up for the Microsoft 365 developer program.":::

1. Sign in to Teams with your new account.
1. In the Teams client, select **Apps**.
1. Verify that you can see the **Upload a custom app** option. If you do, this means you can sideload apps.

:::image type="content" source="../assets/images/build-your-first-app/upload-custom-app-closeup.png" alt-text="Illustration showing where in Teams you can upload a custom app.":::

# [Have a tenant](#tab/have-a-tenant)

If you already have a tenant, verify if you can sideload apps in Teams.

**Verify that you can sideload your apps**

1. In the Teams Client, select **Apps**.
1. Verify that you can see the **Upload a custom app** option. If you do, this means you can sideload apps.

:::image type="content" source="../assets/images/build-your-first-app/upload-custom-app-closeup.png" alt-text="Illustration showing where in Teams you can upload a custom app.":::

---

### Install your development tools

To build this app, you'll use the Teams Toolkit for Visual Studio Code to quickly get started. You can also build Teams apps with any ofyour preffered tools.

> [!NOTE]
> Teams displays app content only through HTTPS connections. To debug certain types of apps locally, such as a bot, you'll learn how to use ngrok to set up a secure tunnel between Teams and your app.
v-vrajaraman marked this conversation as resolved.
Show resolved Hide resolved
>
> Production Teams apps are hosted in the cloud.

**To install Microsoft Teams tools**

1. Install [Node.js](https://nodejs.org/en/).
1. If you plan to build a bot or messaging extension, Install [ngrok](https://ngrok.com/download) and [expose your localhost to the Internet using ngrok](../tutorials/get-started-dotnet-app-studio.md/#tunnel-using-ngrok).
v-vrajaraman marked this conversation as resolved.
Show resolved Hide resolved
1. Install the latest version of [Visual Studio Code](https://code.visualstudio.com/download).

> [!NOTE]
> The toolkit does not support earlier versions of Visual Studio Code.

1. In the left activity bar, select **Extensions** :::image type="icon" source="../assets/icons/vs-code-extensions.png":::.
1. In **Microsoft Teams Toolkit**, select **Install**.
v-vrajaraman marked this conversation as resolved.
Show resolved Hide resolved

:::image type="content" source="../assets/images/build-your-first-app/vsc-install-toolkit.png" alt-text="Illustration showing where in Visual Studio Code you can install the Microsoft Teams Toolkit extension.":::

## 1. Create your app project

Use the Microsoft Teams Toolkit in Visual Studio Code to set up your first app project. Create your app project using the following steps:
1. Open Visual Studio Code.
1. Select **Microsoft Teams Toolkit** :::image type="icon" source="../assets/icons/vsc-toolkit.png"::: > **Create a new Teams app**.
v-vrajaraman marked this conversation as resolved.
Show resolved Hide resolved

1. In Visual Studio Code, select **Microsoft Teams** :::image type="icon" source="../assets/icons/vsc-toolkit.png"::: on the left Activity Bar and choose **Create a new Teams app**.
1. When prompted, sign in with your Microsoft 365 development account.
1. On the **Add capabilities** screen, select **Tab** then **Next**.
:::image type="content" source="../assets/images/build-your-first-app/choose-tab.png" alt-text="Screenshot showing how to configure your app project with the Visual Studio Code Teams Toolkit.":::
1. Enter a name for your Teams app. (This is the default name for your app and also the name of the app project directory on your local machine.)
1. Check only the **Personal tab** option and select **Finish** at the bottom of the screen to configure your project.
:::image type="content" source="../assets/images/build-your-first-app/vscode-teams-toolkit-02.png" alt-text="Screenshot showing how to create your app project with the Visual Studio Code Teams Toolkit.":::

1. Sign in with your Microsoft 365 development account. Either the one you just created or the account you already had that allows app sideloading.
1. On the **Select project** screen, go to **Personal app** and select **JS** (JavaScript) > **Next**.

## 2. Understand important app project components
:::image type="content" source="../assets/images/build-your-first-app/vscode-teams-toolkit-03.png" alt-text="Screenshot showing how to configure your app project with the Visual Studio Code Teams Toolkit.":::

Once the toolkit configures your project, you have the components to build a basic personal tab for Teams. The project directories and files display in the Explorer area of Visual Studio Code.
1. Enter a name for your Teams app.

:::image type="content" source="../assets/images/build-your-first-app/app-project-files.png" alt-text="Screenshot showing app project files for a personal tab in Visual Studio Code.":::
:::image type="content" source="../assets/images/build-your-first-app/vscode-teams-toolkit-04.png" alt-text="Screenshot showing how to add a name to your app project with the Visual Studio Code Teams Toolkit.":::

### App scaffolding
1. Select **Finish**.
Your project is now configured.
v-vrajaraman marked this conversation as resolved.
Show resolved Hide resolved

The toolkit automatically creates scaffolding for you in the `src` directory based on the capabilities you added during setup.
## 2. Understand your app project components

If you create a tab during setup, for example, the `App.js` file in the `src/components` directory is important because it handles the initialization and routing of your app. It calls the [Microsoft Teams JavaScript client SDK](../tabs/how-to/using-teams-client-sdk.md) to establish communication between your app and Teams.
After the toolkit configures your app project, you have the components to build your "Hello, World!" Teams app. The project's directories and files are located in the Visual Studio Code Explorer.

### App ID
:::image type="content" source="../assets/images/build-your-first-app/vscode-teams-toolkit-05.png" alt-text="Screenshot showing the scaffolding in your app project with the Visual Studio Code Teams Toolkit.":::

Configure your app with App Studio using the Teams app ID. Find the ID in the `teamsAppId` object, which is located in your project's `package.json` file.
The toolkit automatically creates app scaffolding in the `src` directory based on the capabilities you added during setup.
Since you created a tab during setup, the `App.js` file in the `src/components` directory handles the initialization and routing of your app. The file also calls the Microsoft Teams JavaScript client SDK to establish communication between your app and Teams.

## 3. Build and run your app

Build and run your app locally to save time. This information is also available in the toolkit `README`. Build and run your app using the following steps:
Build and run your app locally to save time.

1. In a terminal, go to the root directory of your app project and run `npm install`.
1. Run `npm start`.
**To build and run your app**
v-vrajaraman marked this conversation as resolved.
Show resolved Hide resolved

Once complete, there's a **Compiled successfully!** message in the terminal. Your app is running on `https://localhost:3000`.
1. In Visual Studio Code, select **View** > **Terminal**.
1. Run `npm install`.
1. Run `npm start`.

A **Compiled successfully!** message appears in the terminal. Your app is now running on your localhost at `https://localhost:3000`.

## 4. Sideload your app in Teams

Your app is ready to test in Teams. To do this, you must have a Microsoft 365 development account that allows app sideloading. For more information on account opening, see [Teams development account](../build-your-first-app/build-first-app-overview.md#set-up-your-development-account).
Sideloading is the process of installing an app in Teams that hasn't been approved by your admin or Microsoft. Sideloading is common when testing and debugging Teams apps.

> [!TIP]
> Check for issues before sideloading your app, using the [validation feature in App Studio](../concepts/deploy-and-publish/appsource/prepare/submission-checklist.md#teams-app-validation-tool), which is included in the toolkit. Fix the errors to successfully sideload the app.
By default, Teams doesn't allow app sideloading. You can change this setting in the Teams admin center.

Sideload your app in Teams using the following steps:
**To enable app sideloading in Teams**

> [!NOTE]
> To enable sideloading before you sideload your app in Teams, follow the steps in [Turn on app sideloading](../concepts/build-and-test/prepare-your-o365-tenant.md#enable-custom-teams-apps-and-turn-on-custom-app-uploading).
1. Sign in to [Microsoft 365 admin center](https://admin.microsoft.com/Adminportal/Home?source=applauncher#/homepage#/) with your admin credentials.
v-vrajaraman marked this conversation as resolved.
Show resolved Hide resolved
1. Select **Show All** > **Teams**.

1. Select the **F5** key to launch a Teams web client in Visual Studio Code.
1. To display your app content in Teams, specify that where your app is running (`localhost`) is trustworthy:
1. Open a new tab in the same browser window (Google Chrome by default) which opened after pressing **F5**.
1. Go to `https://localhost:3000/tab` and proceed to the page.
1. Go back to Teams. In the dialog, select **Add for me** to install your app.
:::image type="content" source="../assets/images/build-your-first-app/tab-running.png" alt-text="Screenshot showing an example 'Hello, World!' personal tab app running in Teams.":::
![image of admin center menu](~/assets/images/prepare-test-tenant/admin-center.png)

🎉 Congratulations! Your app is running in Teams.
> [!Note]
> It can take up to 24 hours for the **Teams** option to appear.

## Next step
1. Go to **Teams apps** > **Setup policies** > **Global** (Org-wide default).

Expand on the personal tab you just created or build another type of Teams app.
![turn on sideload view](~/assets/images/prepare-test-tenant/turn-on-sideload.png)

1. Turn on the **upload custom apps** toggle.
v-vrajaraman marked this conversation as resolved.
Show resolved Hide resolved

1. Select **Save** to save the changes.
v-vrajaraman marked this conversation as resolved.
Show resolved Hide resolved

Your test tenant now allows custom app sideloading.
v-vrajaraman marked this conversation as resolved.
Show resolved Hide resolved

> [!Note]
> Check for issues before sideloading your app using the validation feature in App Studio, which is included in the toolkit. Fix the errors to successfully sideload the app.


### To sideload your app
v-vrajaraman marked this conversation as resolved.
Show resolved Hide resolved

1. In Visual Studio Code, Open Teams Toolkit.
v-vrajaraman marked this conversation as resolved.
Show resolved Hide resolved
1. Go to **App Studio**.
1. Select **Test and Distribute** > **Install**.

:::image type="content" source="../assets/images/build-your-first-app/vscode-teams-toolkit-appstudio.png" alt-text="Screenshot showing how to sideload your app to Teams client with the Visual Studio Code Teams Toolkit.":::

**Alternatively**

1. Select the **F5** key to open browser window to install. This will skip the installation process in the **App Studio** and lauch Teams in your browser.
1. In the installation dialog, select **Add** to install your app to Teams.

:::image type="content" source="../assets/images/build-your-first-app/vscode-teams-toolkit-install.png" alt-text="Screenshot showing how to sideload your app to Teams client.":::

> [!Note]
> App Studio is also available as a stand-alone app for Teams client.

### Troubleshoot App Studio
heath-hamilton marked this conversation as resolved.
Show resolved Hide resolved

**Installation failed**

If the following error message appears while installing App Studio:

* Something went wrong
* Manifest parsing has failed
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Something went wrong
* Manifest parsing has failed

Added to above sentence.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@v-vrajaraman The message only reads, "Manifest parsing has failed."

image


Verify that the app information is correctly entered.

**To verify the app information**

* In the Teams Toolkit, go to **App Studio** > **App details** and verify that all the required information is correctly entered.
* If you manually edited the `manifest.json` file, verify that the JSON is well-defined in the **App Manifest** tool in App Studio.

**Tab content not displayed**

Verify that your app is running. If it isn't, go to the terminal and run `npm start`.

## See also

* [Prepare your Microsoft 365 tenant](https://docs.microsoft.com/microsoftteams/platform/concepts/build-and-test/prepare-your-o365-tenant)
* [Choosing a setup to test and debug your Microsoft Teams app](../concepts/build-and-test/debug.md)
* [Building tabs and other hosted experiences with the Microsoft Teams JavaScript client SDK](../tabs/how-to/using-teams-client-sdk.md)
* [Prepare for AppSource submission](../concepts/deploy-and-publish/appsource/prepare/submission-checklist.md)
* [Quickly develop apps with App Studio for Microsoft Teams](../concepts/build-and-test/app-studio-overview.md)
* [Build a channel tab](../build-your-first-app/build-channel-tab.md)

## Next step

> [!div class="nextstepaction"]
> [Add to your personal tab](../build-your-first-app/build-personal-tab.md)
> [!div class="nextstepaction"]
> [Build a channel tab](../build-your-first-app/build-channel-tab.md)
> [!div class="nextstepaction"]
> [Build a bot](../build-your-first-app/build-bot.md)
> [Build a personal tab for Microsoft Teams](../build-your-first-app/build-personal-tab.md)