From 317e1c0dbc723b88ed34cb5b8da6ad68035d8eb5 Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Mon, 28 Mar 2022 02:16:04 -0400 Subject: [PATCH] Updated readme, sample.json, and devcontainer --- .../.devcontainer/devcontainer.json | 39 +++++++++++++ .../.devcontainer/spfx-startup.sh | 33 +++++++++++ samples/react-company-stories/README.md | 38 ++++++++----- .../react-company-stories/assets/sample.json | 56 +++++++++++++++++++ 4 files changed, 153 insertions(+), 13 deletions(-) create mode 100644 samples/react-company-stories/.devcontainer/devcontainer.json create mode 100644 samples/react-company-stories/.devcontainer/spfx-startup.sh create mode 100644 samples/react-company-stories/assets/sample.json diff --git a/samples/react-company-stories/.devcontainer/devcontainer.json b/samples/react-company-stories/.devcontainer/devcontainer.json new file mode 100644 index 000000000..896564300 --- /dev/null +++ b/samples/react-company-stories/.devcontainer/devcontainer.json @@ -0,0 +1,39 @@ +// For more information on how to run this SPFx project in a VS Code Remote Container, please visit https://aka.ms/spfx-devcontainer +{ + "name": "SPFx 1.14.0", + "image": "docker.io/m365pnp/spfx:1.14.0", + // Set *default* container specific settings.json values on container create. + "settings": {}, + // Add the IDs of extensions you want installed when the container is created. + "extensions": [ + "editorconfig.editorconfig", + "dbaeumer.vscode-eslint" + ], + // Use 'forwardPorts' to make a list of ports inside the container available locally. + "forwardPorts": [ + 4321, + 35729 + ], + "portsAttributes": { + "4321": { + "protocol": "https", + "label": "Manifest", + "onAutoForward": "silent", + "requireLocalPort": true + }, + // Not needed for SPFx>= 1.12.1 + // "5432": { + // "protocol": "https", + // "label": "Workbench", + // "onAutoForward": "silent" + // }, + "35729": { + "protocol": "https", + "label": "LiveReload", + "onAutoForward": "silent", + "requireLocalPort": true + } + }, + "postCreateCommand": "bash .devcontainer/spfx-startup.sh", + "remoteUser": "node" +} diff --git a/samples/react-company-stories/.devcontainer/spfx-startup.sh b/samples/react-company-stories/.devcontainer/spfx-startup.sh new file mode 100644 index 000000000..456d6aea8 --- /dev/null +++ b/samples/react-company-stories/.devcontainer/spfx-startup.sh @@ -0,0 +1,33 @@ +echo +echo -e "\e[1;94mInstalling Node dependencies\e[0m" +npm install + +## commands to create dev certificate and copy it to the root folder of the project +echo +echo -e "\e[1;94mGenerating dev certificate\e[0m" +gulp trust-dev-cert + +# Convert the generated PEM certificate to a CER certificate +openssl x509 -inform PEM -in ~/.rushstack/rushstack-serve.pem -outform DER -out ./spfx-dev-cert.cer + +# Copy the PEM ecrtificate for non-Windows hosts +cp ~/.rushstack/rushstack-serve.pem ./spfx-dev-cert.pem + +## add *.cer to .gitignore to prevent certificates from being saved in repo +if ! grep -Fxq '*.cer' ./.gitignore + then + echo "# .CER Certificates" >> .gitignore + echo "*.cer" >> .gitignore +fi + +## add *.pem to .gitignore to prevent certificates from being saved in repo +if ! grep -Fxq '*.pem' ./.gitignore + then + echo "# .PEM Certificates" >> .gitignore + echo "*.pem" >> .gitignore +fi + +echo +echo -e "\e[1;92mReady!\e[0m" + +echo -e "\n\e[1;94m**********\nOptional: if you plan on using gulp serve, don't forget to add the container certificate to your local machine. Please visit https://aka.ms/spfx-devcontainer for more information\n**********" \ No newline at end of file diff --git a/samples/react-company-stories/README.md b/samples/react-company-stories/README.md index 6b6072412..a7be040fd 100644 --- a/samples/react-company-stories/README.md +++ b/samples/react-company-stories/README.md @@ -1,4 +1,4 @@ -# Company Stories Web part +# Company Stories ## Summary @@ -6,11 +6,10 @@ This web part allows you to add images to a SharePoint List, and renders them wi ![react-company-stories](./assets/react-company-stories.gif) - ## Compatibility -![SPFx 1.14](https://img.shields.io/badge/SPFx-1.14-green.svg) -![Node.js v14](https://img.shields.io/badge/Node.js-v14-green.svg) +![SPFx 1.14](https://img.shields.io/badge/SPFx-1.14-green.svg) +![Node.js v14](https://img.shields.io/badge/Node.js-v14-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) ![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") @@ -27,7 +26,7 @@ This web part allows you to add images to a SharePoint List, and renders them wi ## Prerequisites - Before deploying your SharePoint Framework package to your tenant, you will need to deploy the @microsoft/mgt-spfx SharePoint Framework package to your tenant. You can download the package corresponding to the version of @microsoft/mgt-spfx that you used in your project, from the [Releases](https://github.com/microsoftgraph/microsoft-graph-toolkit/releases) section on GitHub. -See here for more information about using Microsoft Graph Toolkit components in SPFx: https://docs.microsoft.com/en-gb/graph/toolkit/get-started/mgt-spfx +See here for more information about using Microsoft Graph Toolkit components in SPFx: - A SharePoint list called "Stories" with the following fields: - Image: image field type - Content: multi-line field type @@ -48,21 +47,19 @@ Version|Date|Comments 1.0|March 31, 2021|Initial release 2.0|March 16, 2022|Upgraded to SPFx v1.14. Issue 2442 fixed. Using latest MGT version - - -## Minimal Path to Awesome +## Minimal path to awesome - Before deploying your SharePoint Framework package to your tenant, you will need to deploy the @microsoft/mgt-spfx SharePoint Framework package to your tenant. You can download the package corresponding to the version of @microsoft/mgt-spfx that you used in your project, from the [Releases](https://github.com/microsoftgraph/microsoft-graph-toolkit/releases) section on GitHub. -See here for more information about using Microsoft Graph Toolkit components in SPFx: https://docs.microsoft.com/en-gb/graph/toolkit/get-started/mgt-spfx +See here for more information about using Microsoft Graph Toolkit components in SPFx: - Configure SharePoint permissions to Graph API (see Prerequisites). Suggest you to use the [Microsoft 365 CLI](https://blog.mastykarz.nl/grant-api-permissions-office-365-cli/) -- Clone this repository -- Ensure that you are at the solution folder +- 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-company-stories) then unzip it) +- From your command line, change your current directory to the directory containing this sample (`react-company-stories`, located under `samples`) - In the command-line run: - `npm install` - `gulp serve --nobrowser` - Add the web part to the SharePoint Workbench (same Site where the List was created) -> This sample can also be opened with [VS Code Remote Development](https://code.visualstudio.com/docs/remote/remote-overview). Visit https://aka.ms/spfx-devcontainer for further instructions. +> This sample can also be opened with [VS Code Remote Development](https://code.visualstudio.com/docs/remote/remote-overview). Visit for further instructions. ## Features @@ -83,9 +80,24 @@ About SPFx: - [Publish SharePoint Framework applications to the Marketplace](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/publish-to-marketplace-overview) - [Microsoft 365 Patterns and Practices](https://aka.ms/m365pnp) - Guidance, tooling, samples and open-source controls for your Microsoft 365 development +## 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-company-stories%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-company-stories) and see what the community is saying. + +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%2Csample%3A%20react-company-stories&template=bug-report.yml&sample=react-company-stories&authors=@luismanez&title=react-company-stories%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-company-stories&template=question.yml&sample=react-company-stories&authors=@luismanez&title=react-company-stories%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-company-stories&template=suggestion.yml&sample=react-company-stories&authors=@luismanez&title=react-company-stories%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.** +**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.** diff --git a/samples/react-company-stories/assets/sample.json b/samples/react-company-stories/assets/sample.json new file mode 100644 index 000000000..ee048a8d1 --- /dev/null +++ b/samples/react-company-stories/assets/sample.json @@ -0,0 +1,56 @@ +[ + { + "name": "pnp-sp-dev-spfx-web-parts-react-company-stories", + "source": "pnp", + "title": "Company Stories", + "shortDescription": "This web part allows you to add images to a SharePoint List, and renders them with a UX very similar to Instagram Stories (or Twitter Reels, or [Place your Social network here]). It is a way to engage employees, showing relevant content in a well-known visual appearance.", + "url": "https://github.com/pnp/sp-dev-fx-webparts/tree/main/samples/react-company-stories", + "downloadUrl": "https://pnp.github.io/download-partial/?url=https://github.com/pnp/sp-dev-fx-webparts/tree/main/samples/react-company-stories", + "longDescription": [ + "This web part allows you to add images to a SharePoint List, and renders them with a UX very similar to Instagram Stories (or Twitter Reels, or [Place your Social network here]). It is a way to engage employees, showing relevant content in a well-known visual appearance." + ], + "creationDateTime": "2021-03-31", + "updateDateTime": "2022-03-16", + "products": [ + "SharePoint" + ], + "metadata": [ + { + "key": "CLIENT-SIDE-DEV", + "value": "React" + }, + { + "key": "SPFX-VERSION", + "value": "1.14" + } + ], + "thumbnails": [ + { + "type": "image", + "order": 100, + "url": "https://github.com/pnp/sp-dev-fx-webparts/raw/main/samples/react-company-stories/assets/react-company-stories.gif", + "alt": "Web Part Preview" + }, + { + "type": "image", + "order": 101, + "url": "https://github.com/pnp/sp-dev-fx-webparts/raw/main/samples/react-company-stories/assets/stories-list.png", + "alt": "Web Part Preview" + } + ], + "authors": [ + { + "gitHubAccount": "luismanez", + "pictureUrl": "https://github.com/luismanez.png", + "name": "Luis Mañez" + } + ], + "references": [ + { + "name": "Build your first SharePoint client-side web part", + "description": "Client-side web parts are client-side components that run in the context of a SharePoint page. Client-side web parts can be deployed to SharePoint environments that support the SharePoint Framework. You can also use modern JavaScript web frameworks, tools, and libraries to build them.", + "url": "https://docs.microsoft.com/en-us/sharepoint/dev/spfx/web-parts/get-started/build-a-hello-world-web-part" + } + ] + } +]