diff --git a/samples/react-pnpjs-spsite-er-diagram/README.md b/samples/react-pnpjs-spsite-er-diagram/README.md index eec639c89..66a7b239a 100644 --- a/samples/react-pnpjs-spsite-er-diagram/README.md +++ b/samples/react-pnpjs-spsite-er-diagram/README.md @@ -1,73 +1,119 @@ -# react-pnpjs-spsite-er-diagram - +# Site ER Diagram ## Summary -Short summary on functionality and used technologies. +This web parts loads all lists on a site and display it in a Entity Relationship Diagram (ERD). -[picture of the solution in action, if possible] +![Best to create a AppPage with the webpart](assets/SPERasAppPage.png) +![ER Webpart in fullscreen](assets/SPERasAppPageFullScreen.png) -## Used SharePoint Framework Version - -![version](https://img.shields.io/badge/version-1.13-green.svg) +## Compatibility +![SPFx 1.14](https://img.shields.io/badge/SPFx-1.14-green.svg) +![Node.js v14 | v12](https://img.shields.io/badge/Node.js-v14%20%7C%20v12-green.svg) +![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg) +![Does not work with SharePoint 2019](https://img.shields.io/badge/SharePoint%20Server%202019-Incompatible-red.svg "SharePoint Server 2019 requires SPFx 1.4.1 or lower") +![Does not work with SharePoint 2016 (Feature Pack 2)](https://img.shields.io/badge/SharePoint%20Server%202016%20(Feature%20Pack%202)-Incompatible-red.svg "SharePoint Server 2016 Feature Pack 2 requires SPFx 1.1") +![Local Workbench Unsupported](https://img.shields.io/badge/Local%20Workbench-Unsupported-red.svg "Local workbench is no longer available as of SPFx 1.13 and above") +![Hosted Workbench Compatible](https://img.shields.io/badge/Hosted%20Workbench-Compatible-green.svg) +![Compatible with Remote Containers](https://img.shields.io/badge/Remote%20Containers-Compatible-green.svg) ## Applies to -- [SharePoint Framework](https://aka.ms/spfx) -- [Microsoft 365 tenant](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/set-up-your-developer-tenant) - +* [SharePoint Framework](https://docs.microsoft.com/sharepoint/dev/spfx/sharepoint-framework-overview) +* [Microsoft 365 tenant](https://docs.microsoft.com/sharepoint/dev/spfx/set-up-your-development-environment) > Get your own free development tenant by subscribing to [Microsoft 365 developer program](http://aka.ms/o365devprogram) -## Prerequisites - -> Any special pre-requisites? - ## Solution + + +Solution|Author(s) +--------|--------- +react-pnpjs-spsite-er-diagram | [Niklas Wilhelm](https://github.com/ICTNiklasWilhelm) ([@NiklasWilhelm4](https://twitter.com/@NiklasWilhelm4)), NetForce 365 GmbH (HubSite 365) ## Version history -| Version | Date | Comments | -| ------- | ---------------- | --------------- | -| 1.1 | March 10, 2021 | Update comment | -| 1.0 | January 29, 2021 | Initial release | +Version|Date|Comments +-------|----|-------- +1.0|October 07, 2022|Initial release -## Disclaimer +## Minimal path to awesome +* Clone this repository (or [download this solution as a .ZIP file](https://pnp.github.io/download-partial/?url=https://github.com/pnp/sp-dev-fx-webparts/tree/main/samples/react-pnpjs-spsite-er-diagram) then unzip it) +* From your command line, change your current directory to the directory containing this sample (`react-pnpjs-spsite-er-diagram`, located under `samples`) +* in the command line run: + * `npm install` + * `gulp serve` -**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 -- Ensure that you are at the solution folder -- in the command-line run: - - **npm install** - - **gulp serve** - -> Include any additional steps as needed. +> This sample can also be opened with [VS Code Remote Development](https://code.visualstudio.com/docs/remote/remote-overview). Visit for further instructions. ## Features -Description of the extension that expands upon high-level summary above. +This project can be used as a starting point for any visualisation of SharePoint Data. Currently it's using GoJS as dependency for the ER Diagram (in productive enviroment you would need to get a license for it). The data layer is abstract so it's possible to use a different library (like three.js) as presentation layer. -This extension illustrates the following concepts: +* the Data gets cached, to see changes made to the lists/lookups a "refresh" is needed +* alerts/warnings for the lists are displayed as well (Versioning/ItemCount/Threshholdlimit/..) +* easy opt/in/out of alerts and fields +* easy switch between Internal-/DisplayName +* Download current canvas as image -- topic 1 -- topic 2 -- topic 3 + -> Notice that better pictures and documentation will increase the sample usage and the value you are providing for others. Thanks for your submissions advance. + + +## 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](https://pnp.github.io/cli-microsoft365/cmd/spfx/spfx-doctor/) from within the solution folder to diagnose incompatibility issues with your environment. + +You can try looking at [issues related to this sample](https://github.com/pnp/sp-dev-fx-webparts/issues?q=label%3A%22sample%3A%20react-pnpjs-spsite-er-diagram%22) to see if anybody else is having the same issues. + +You can also try looking at [discussions related to this sample](https://github.com/pnp/sp-dev-fx-webparts/discussions?discussions_q=react-pnpjs-spsite-er-diagram) and see what the community is saying. + +If you encounter any issues using this sample, [create a new issue](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected%2Csample%3A%20react-pnpjs-spsite-er-diagram&template=bug-report.yml&sample=react-pnpjs-spsite-er-diagram&authors=@YOURGITHUBUSERNAME&title=react-pnpjs-spsite-er-diagram%20-%20). + +For questions regarding this sample, [create a new question](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Aquestion%2Csample%3A%20react-pnpjs-spsite-er-diagram&template=question.yml&sample=react-pnpjs-spsite-er-diagram&authors=@YOURGITHUBUSERNAME&title=react-pnpjs-spsite-er-diagram%20-%20). + +Finally, if you have an idea for improvement, [make a suggestion](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Aenhancement%2Csample%3A%20react-pnpjs-spsite-er-diagram&template=suggestion.yml&sample=react-pnpjs-spsite-er-diagram&authors=@YOURGITHUBUSERNAME&title=react-pnpjs-spsite-er-diagram%20-%20). + +## 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.** + + \ No newline at end of file diff --git a/samples/react-pnpjs-spsite-er-diagram/assets/SPERasAppPage.png b/samples/react-pnpjs-spsite-er-diagram/assets/SPERasAppPage.png new file mode 100644 index 000000000..fbfd21cdd Binary files /dev/null and b/samples/react-pnpjs-spsite-er-diagram/assets/SPERasAppPage.png differ diff --git a/samples/react-pnpjs-spsite-er-diagram/assets/SPERasAppPageFullScreen.png b/samples/react-pnpjs-spsite-er-diagram/assets/SPERasAppPageFullScreen.png new file mode 100644 index 000000000..b6ace00e3 Binary files /dev/null and b/samples/react-pnpjs-spsite-er-diagram/assets/SPERasAppPageFullScreen.png differ diff --git a/samples/react-pnpjs-spsite-er-diagram/config/package-solution.json b/samples/react-pnpjs-spsite-er-diagram/config/package-solution.json index 5249b3a56..7782a812d 100644 --- a/samples/react-pnpjs-spsite-er-diagram/config/package-solution.json +++ b/samples/react-pnpjs-spsite-er-diagram/config/package-solution.json @@ -5,7 +5,7 @@ "id": "d0130471-1806-4c7d-a504-9af696d7ed0f", "version": "1.0.0.0", "includeClientSideAssets": true, - "skipFeatureDeployment": true, + "skipFeatureDeployment": false, "isDomainIsolated": false, "developer": { "name": "",