sp-dev-fx-webparts/samples/react-feedback/README.md

78 lines
3.4 KiB
Markdown
Raw Normal View History

# Feedback
## Summary
2020-12-17 00:06:13 -05:00
This is an application that supports Feedback through a web part that can be used directly on a Modern SharePoint Site page. This web part can be added to any site page or article. This allows users to send categorized feedback via email to users in the "Feedback Owners" group.
![Feedback](./assets/feedbackwebpart.gif)
2020-12-17 00:06:13 -05:00
## Compatibility
![SPFx 1.11](https://img.shields.io/badge/SPFx-1.11-green.svg)
![Node.js LTS 10.x](https://img.shields.io/badge/Node.js-LTS%2010.x-green.svg)
![SharePoint Online](https://img.shields.io/badge/SharePoint-Online-red.svg)
![Teams N/A](https://img.shields.io/badge/Teams-N%2FA-lightgrey.svg)
![Workbench Not supported](https://img.shields.io/badge/Workbench-Not%20Supported-lightgrey.svg)
## Applies to
* [SharePoint Framework](https://docs.microsoft.com/sharepoint/dev/spfx/sharepoint-framework-overview)
* [Office 365 tenant](https://docs.microsoft.com/sharepoint/dev/spfx/set-up-your-development-environment)
## Prerequisites
* Office 365 subscription with SharePoint Online
* SharePoint Framework [development environment](https://docs.microsoft.com/sharepoint/dev/spfx/set-up-your-development-environment) set up
2020-12-17 00:06:13 -05:00
* "Feedback Owners" SharePoint group (see below)
## Solution
Solution|Author(s)
--------|---------
2021-03-02 19:19:18 -05:00
react-feedback | Perry Kankam
react-feedback | Abderahman Moujahid
## Version history
Version|Date|Comments
-------|----|--------
2021-03-02 19:19:18 -05:00
1.0.0|December 15, 2020|Initial release
1.0.1|March 3, 2021|Fix undefined listItem
## 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
*To really get the full experience go to the workbench on a SharePoint Site [Your site url]/_layouts/15/workbench.aspx and that's where the magic will happen but this requires that you deploy and activate features to provision the required SharePoint assets*
* Clone this repository
* in the command line run:
* `npm install`
* `gulp serve`
2020-12-17 00:06:13 -05:00
* Add "Feedback Owners" SharePoint group. This is where you'll add all users who should receive this feedback.
* Run one of the following custom commands to clean, build, bundle and package the solution.
* If you want to be able to debug using your local code using gulp serve
`gulp package`
* Navigate to the output `feedback-webpart.sppkg` (found in the `/sharepoint/solution` folder)
* Upload it to an application catalog (either a tenant or site collection one)
* In your site collection go to **Site Contents** and click **New** > **App**
2020-12-17 00:06:13 -05:00
* Find and add the **Feedback Application** App
* wait for it to finish installing and activating features on the **Site Contents** page
* Go to a site page like home, edit the page and find and add the **Feedback** web part
* If you deployed a shippable (SharePoint Online) version you don't need to do anything else
* If you deployed a debug (http://localhost:4321) version you'll need to ensure gulp serve is running
## Features
2020-12-17 00:06:13 -05:00
This sample illustrates the following concepts:
- Used [@pnp/polyfill-ie11](https://pnp.github.io/pnpjs/concepts/polyfill/)
- Used [PnP](https://pnp.github.io/pnpjs/) for communication with SharePoint.
- Used [@pnp/logging](https://pnp.github.io/pnpjs/logging/)
2020-12-17 00:06:13 -05:00
<img src="https://telemetry.sharepointpnp.com/sp-dev-fx-webparts/samples/react-feedback" />