Skip to content

Commit

Permalink
- Added documentation fro Teams app
Browse files Browse the repository at this point in the history
  • Loading branch information
Franck Cornu committed Jun 7, 2024
1 parent 1f36b68 commit a0958c1
Show file tree
Hide file tree
Showing 8 changed files with 48 additions and 2 deletions.
2 changes: 1 addition & 1 deletion documentation/docs/development-guide/_category_.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@
"position": 4,
"link": {
"type": "generated-index",
"description": "Development guide fro contributors and maintainers."
"description": "Development guide for contributors and maintainers."
}
}
2 changes: 1 addition & 1 deletion documentation/docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar_position: 1
# Introduction


PnP Modern Search Core Components are components you can reuse in your applications/projects to leverage information indexed in the Microsoft search engine inside your organization. We provide reusable components that can be used either in custom made applications through [**web components**](./web-components/available-components) or as [**SharePoint Web Parts**](./sharepoint-webparts/installation) to be added to your sites.
PnP Modern Search Core Components are components you can reuse in your applications/projects to leverage information indexed in the Microsoft search engine inside your organization. We provide reusable components that can be used either in custom made applications through [**web components**](./web-components/available-components), [**SharePoint Web Parts**](./sharepoint-webparts/installation) to be added to your sites or as [Microsoft Teams tab/personal application](./teams-app/solution.md).

:::info
These components are base on regular [web components](https://developer.mozilla.org/en-US/docs/Web/Web_Components) built on top of [Microsoft Graph Toolkit](https://learn.microsoft.com/en-us/graph/toolkit/overview), [FAST Components](https://www.fast.design/) and [Lit](https://lit.dev/docs/).
Expand Down
8 changes: 8 additions & 0 deletions documentation/docs/teams-app/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "Teams application",
"position": 4,
"link": {
"type": "generated-index",
"description": "Demo Teams application showcasing the integration of components."
}
}
Binary file added documentation/docs/teams-app/img/add_app.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added documentation/docs/teams-app/img/approve_app.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added documentation/docs/teams-app/img/teams_app.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
38 changes: 38 additions & 0 deletions documentation/docs/teams-app/solution.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Usage

A demo Microsoft Teams application package is provided with the solution:

<div className='center'>
!["Teams application"](./img/teams_app.png)
</div>

It showcases the following concepts:

- Web components package consumption
- Theme handling
- Single-Sign On within Teams

## Deployment

To test it, you can either:

1. Get the latest package `appPackage.prod.zip` from the GitHub repository: [https://github.com/microsoft-search/pnp-modern-search-core-components/releases](https://github.com/microsoft-search/pnp-modern-search-core-components/releases)

2. Enable [custom app side loading](https://learn.microsoft.com/en-us/microsoftteams/platform/concepts/build-and-test/prepare-your-o365-tenant#enable-custom-teams-apps-and-turn-on-custom-app-uploading) in your Teams administration center and add the app manually.

3. [Deploy the application to the global Teams app catalog](https://learn.microsoft.com/en-us/microsoftteams/manage-apps?toc=%2Fmicrosoftteams%2Fplatform%2Ftoc.json&bc=%2FMicrosoftTeams%2Fbreadcrumb%2Ftoc.json) so it will be available for your users.


This application uses a dedicated multi-tenant Entra ID application with the predefined permissions. The first time you launch the solution, you will be asked to approve the application:

<div className='center'>
!["Approve app permissions"](./img/approve_app.png)
</div>

<div className='center'>
!["Approve app permissions"](./img/approve_permissions.png)
</div>

:::danger DOT NOT USE THIS APP IN PRODUCTION
This application is not suitable for production usage a it uses development infrastructure with no guarantee whatsoever. Its purpose is to show you the Teams integration with PnP Modern Search components without building hte application yourself. If you want to integrate the application into your environment, [please follow the development guide](../development-guide/teams/getting_started)
:::

0 comments on commit a0958c1

Please sign in to comment.