sp-dev-fx-webparts/samples/react-private-libraries/README.md

116 lines
4.6 KiB
Markdown
Raw Normal View History

2021-07-02 14:07:44 -04:00
# Private Folder Manager
## Summary
This sample provides a webpart that can be used to manage Document Libraries with Secured Subfolders. The use case this was developed for is a Request for Proposal site. A Document library is created for each RFP and subfolders are created within that Library for each external supplier invited to participate in that RFP.
The application manages all the security groups set up for the various libraries and folders so that suppliers only see RFP's they were ivited to participate in and only thier folders.
2021-07-02 15:44:33 -04:00
![mainpanel](assets/HomeScreen.png "Main Screen")
2021-07-02 14:20:00 -04:00
2021-07-02 15:44:33 -04:00
![AddingAlibrary](assets/AddALibrary.png "Add A library")
2021-07-02 14:20:00 -04:00
2021-07-02 15:44:33 -04:00
![ManagingFolders](assets/ManageFolders.png "Manage Folders")
2021-07-02 14:20:00 -04:00
2021-07-02 15:44:33 -04:00
![AddingAfolder](assets/AddAFolder.png "Add a folder")
2021-07-02 14:20:00 -04:00
2021-07-02 15:44:33 -04:00
![Configuration](assets/Configuration.png "Configuration")
2021-07-02 14:20:00 -04:00
2021-07-02 14:07:44 -04:00
## Compatibility
![SPFx 1.12.1](https://img.shields.io/badge/SPFx-1.12.1-green.svg)
![Node.js LTS v14 | LTS v12 | LTS v10](https://img.shields.io/badge/Node.js-LTS%20v14%20%7C%20LTS%20v12%20%7C%20LTS%20v10-green.svg)
![SharePoint Online](https://img.shields.io/badge/SharePoint-Online-yellow.svg)
![Teams N/A: Untested with Microsoft Teams](https://img.shields.io/badge/Teams-N%2FA-lightgrey.svg "Untested with Microsoft Teams")
![Workbench Local | Hosted](https://img.shields.io/badge/Workbench-Local%20%7C%20Hosted-green.svg)
2021-07-02 14:41:54 -04:00
2021-07-02 14:07:44 -04:00
## Applies to
* [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)
> Update accordingly as needed.
> DELETE THIS PARAGRAPH BEFORE SUBMITTING
## Solution
Solution|Author(s)
--------|---------
react Private Folder Manager | [Russell Gove](https://github.com/russgove) ([@russgove](https://twitter.com/russgove))
## Version history
Version|Date|Comments
-------|----|--------
1.0|July 2, 2021|Initial release
## Prerequisites
## Minimal Path to Awesome
* Clone this repository
* in the command line run:
* `npm install`
* `gulp serve`
2021-07-02 18:08:31 -04:00
Create two Lists to hold the List of RFX's and the list of RFX Folders.
The lists must have the schemas below (using site content types is not needed)
The RFX List:
2021-07-02 18:15:00 -04:00
![rfx](assets/RFX.PNG "RFX")
2021-07-02 18:08:31 -04:00
(The title was renamed to RFX Number)
The RFX Folder List
2021-07-02 18:15:00 -04:00
![rfxfolders](assets/RFXFolders.PNG "RFXFolders")
2021-07-02 18:08:31 -04:00
(The RFx column is a lookup to the Title/RFX Number in the RFx list)
2021-07-03 09:51:49 -04:00
The scripts folder contains a site script (rfx.json) that can be used to create thses lists.
The PowershellScript AddLists.ps1 in the same folder can be run to applt the script and create the lists
2021-07-02 14:07:44 -04:00
## 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
2021-07-02 14:38:27 -04:00
2021-07-02 14:07:44 -04:00
## 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.**
## Help
We do not support samples, but we 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 encounter any issues while 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&template=bug-report.yml&sample=YOUR-SOLUTION-NAME&authors=@YOURGITHUBUSERNAME&title=YOUR-SOLUTION-NAME%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%3Abug-suspected&template=question.yml&sample=YOUR-SOLUTION-NAME&authors=@YOURGITHUBUSERNAME&title=YOUR-SOLUTION-NAME%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%3Abug-suspected&template=suggestion.yml&sample=YOUR-SOLUTION-NAME&authors=@YOURGITHUBUSERNAME&title=YOUR-SOLUTION-NAME%20-%20).
<img src="https://telemetry.sharepointpnp.com/sp-dev-fx-webparts/samples/YOUR-SOLUTION-NAME" />
This package produces the following:
* lib/* - intermediate-stage commonjs build artifacts
* dist/* - the bundled script, along with other resources
* deploy/* - all resources which should be uploaded to a CDN.
### Build options
gulp clean - TODO
gulp test - TODO
gulp serve - TODO
gulp bundle - TODO
gulp package-solution - TODO