diff --git a/samples/react-graph-personalemail/README.md b/samples/react-graph-personalemail/README.md index 23cf514df..298e79cf4 100644 --- a/samples/react-graph-personalemail/README.md +++ b/samples/react-graph-personalemail/README.md @@ -1,26 +1,54 @@ -## spfx-personal-email +# Personal e-mail -This is where you include your WebPart documentation. +## Summary -### Building the code +Sample React web part showing how to retrieve and display personal e-mail retrieved using the Microsoft Graph. -```bash -git clone the repo -npm i -npm i -g gulp -gulp -``` +![SharePoint Framework web part showing latest personal e-mails](./assets/preview.png) -This package produces the following: +## Used SharePoint Framework Version +![drop](https://img.shields.io/badge/drop-1.6.0-green.svg) -* lib/* - intermediate-stage commonjs build artifacts -* dist/* - the bundled script, along with other resources -* deploy/* - all resources which should be uploaded to a CDN. +## Applies to -### Build options +* [SharePoint Framework](http://dev.office.com/sharepoint/docs/spfx/sharepoint-framework-overview) +* [Office 365 developer tenant](http://dev.office.com/sharepoint/docs/spfx/set-up-your-developer-tenant) -gulp clean - TODO -gulp test - TODO -gulp serve - TODO -gulp bundle - TODO -gulp package-solution - TODO +## Solution + +Solution|Author(s) +--------|--------- +react-graph-personalemail|Waldek Mastykarz (MVP, Rencore, @waldekm) + +## Version history + +Version|Date|Comments +-------|----|-------- +1.0|October 3, 2018|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 repo +* in the command line run: + * `npm i` + * `gulp bundle --ship` + * `gulp package-solution --ship` +* deploy the package to your app catalog +* approve the API permission request to access e-mails using Microsoft Graph +* add the web part to a page + +## Features + +This sample illustrates the following concepts on top of the SharePoint Framework: + +* using the MSGraphClient to communicate with the Microsoft Graph in a SharePoint Framework solution +* requesting API permissions in a SharePoint Framework package +* retrieving e-mails using the Microsoft Graph +* using the MSGraphClient in a SharePoint Framework web part + + diff --git a/samples/react-graph-personalemail/assets/preview.png b/samples/react-graph-personalemail/assets/preview.png new file mode 100644 index 000000000..7be8a4b6d Binary files /dev/null and b/samples/react-graph-personalemail/assets/preview.png differ