sp-dev-fx-webparts/samples/README-template.md

9.8 KiB

Title of the sample

Summary

Short summary on functionality and used technologies.

picture of the web part in action

Compatibility

SPFx 1.13.0 Node.js v14 | v12 Compatible with SharePoint Online Does not work with SharePoint 2019 Does not work with SharePoint 2016 (Feature Pack 2) Local Workbench Unsupported Hosted Workbench Compatible

Applies to

Solution

Solution Author(s)
folder name Author Name (@yourtwitterhandle), Company

Version history

Version Date Comments
1.1 November 1, 2021 Update comment
1.0 October 29, 2021 Initial release

Prerequisites

Minimal Path to Awesome

  • Clone this repository
  • From your command line, change your current directory to the directory containing this sample (YOUR-SOLUTION-NAME, located under samples)
  • in the command line run:
    • npm install
    • gulp serve

Features

Description of the web part with possible additional details than in short summary. This Web Part illustrates the following concepts on top of the SharePoint Framework:

  • topic 1
  • topic 2
  • topic 3

Help

We do not support samples, but this community is always willing to help, and we want to improve these samples. We use GitHub to track issues, which makes it easy for community members to volunteer their time and help resolve issues.

If you're having issues building the solution, please run spfx doctor from within the solution folder to diagnose incompatibility issues with your environment.

You can try looking at issues related to this sample to see if anybody else is having the same issues.

You can also try looking at discussions related to this sample and see what the community is saying.

If you encounter any issues while using this sample, create a new issue.

For questions regarding this sample, create a new question.

Finally, if you have an idea for improvement, make a suggestion.

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.