Add ReadMe and assets
This commit is contained in:
parent
2dd81b2df4
commit
9b1543c3b2
76
README.md
76
README.md
|
@ -1,27 +1,65 @@
|
|||
## react-teams-tabs-pnpjs
|
||||
# react-teams-tabs-pnpjs
|
||||
|
||||
This is where you include your WebPart documentation.
|
||||
## Summary
|
||||
|
||||
A SPFx WebPart using [@pnp/graph/teams](https://pnp.github.io/pnpjs/graph/docs/teams/) that show Channels and Tabs from a Modern Team Site connected to Microsoft Teams
|
||||
The WebPart will show the list of all channels of the Modern Team Sites linked teams. Nested inside Channels list, you will find Tabs link.
|
||||
|
||||
## react-teams-tabs-pnpjs preview
|
||||
![WebPartInAction](./assets/react-teams-tabs-pnpjs-webpart.png)
|
||||
|
||||
## react-teams-tabs-pnpjs in action
|
||||
![WebPartInAction](./assets/react-teams-tabs-pnpjs-webpart-animated.gif)
|
||||
|
||||
|
||||
### Building the code
|
||||
## Used SharePoint Framework Version
|
||||
|
||||
```bash
|
||||
git clone the repo
|
||||
npm i
|
||||
npm i -g gulp
|
||||
gulp
|
||||
```
|
||||
![drop](https://img.shields.io/badge/version-1.9.1-green.svg)
|
||||
|
||||
This package produces the following:
|
||||
## Applies to
|
||||
|
||||
* lib/* - intermediate-stage commonjs build artifacts
|
||||
* dist/* - the bundled script, along with other resources
|
||||
* deploy/* - all resources which should be uploaded to a CDN.
|
||||
* [SharePoint Framework](https:/dev.office.com/sharepoint)
|
||||
* [Office 365 tenant](https://dev.office.com/sharepoint/docs/spfx/set-up-your-development-environment)
|
||||
|
||||
## Solution
|
||||
|
||||
Solution|Author(s)
|
||||
--------|---------
|
||||
react-teams-tabs-pnpjs | [Federico Porceddu](https://www.federicoporceddu.com)
|
||||
|
||||
## Version history
|
||||
|
||||
Version|Date|Comments
|
||||
-------|----|--------
|
||||
1.0|November 30, 2019|Initial release
|
||||
|
||||
## Disclaimer
|
||||
|
||||
**THIS CODE IS PROVIDED *AS IS* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.**
|
||||
|
||||
---
|
||||
|
||||
## Minimal Path to Awesome
|
||||
|
||||
* Clone this repository
|
||||
* in the command line run:
|
||||
* restore dependencies: `npm install`
|
||||
* build solution `gulp build --ship`
|
||||
* bundle solution: `$ gulp bundle --ship`
|
||||
* package solution: `$ gulp package-solution --ship`
|
||||
* locate solution at `.\sharepoint\solution\react-teams-tabs-pnpjs.sppkg`
|
||||
* upload it to your tenant app catalog
|
||||
* [approve permission requests](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-aadhttpclient#manage-permission-requests) from this SharePoint Framework WebPart
|
||||
* add `react-teams-tabs-pnpjs` app to your site
|
||||
* add `react-teams-tabs-pnpjs` webpart to your page to see it in action
|
||||
|
||||
## Features
|
||||
|
||||
This Web Part illustrates the following concepts on top of the SharePoint Framework:
|
||||
|
||||
* How to use Microsoft Graph with PnPJS
|
||||
* [@pnp/graph/teams](https://pnp.github.io/pnpjs/graph/docs/teams/)
|
||||
* How to configure SharePoint Online Tenant and SPFx solution to allow Microsoft Graph calls.
|
||||
* Microsoft Graph API for Microsoft Teams
|
||||
|
||||
### Build options
|
||||
|
||||
gulp clean - TODO
|
||||
gulp test - TODO
|
||||
gulp serve - TODO
|
||||
gulp bundle - TODO
|
||||
gulp package-solution - TODO
|
||||
|
|
Binary file not shown.
After Width: | Height: | Size: 1.1 MiB |
Binary file not shown.
After Width: | Height: | Size: 7.7 KiB |
Loading…
Reference in New Issue