diff --git a/samples/react-poll/.devcontainer/devcontainer.json b/samples/react-poll/.devcontainer/devcontainer.json new file mode 100644 index 000000000..183984b53 --- /dev/null +++ b/samples/react-poll/.devcontainer/devcontainer.json @@ -0,0 +1,38 @@ +{ + "name": "SPFx 1.17.1", + "image": "docker.io/m365pnp/spfx:1.17.1", + "customizations": { + "vscode": { + "extensions": [ + "editorconfig.editorconfig", + "dbaeumer.vscode-eslint" + ] + } + }, + "forwardPorts": [ + 4321, + 35729, + 5432 + ], + "portsAttributes": { + "4321": { + "protocol": "https", + "label": "Manifest", + "onAutoForward": "silent", + "requireLocalPort": true + }, + "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-poll/.devcontainer/spfx-startup.sh b/samples/react-poll/.devcontainer/spfx-startup.sh new file mode 100644 index 000000000..456d6aea8 --- /dev/null +++ b/samples/react-poll/.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-poll/README.md b/samples/react-poll/README.md index b6355e111..02fa11472 100644 --- a/samples/react-poll/README.md +++ b/samples/react-poll/README.md @@ -1,240 +1,100 @@ - - # React Poll - - - - ## Summary - - - - This web part allow User to add New Poll Questions and their options. End users can submit his/her response to the poll. After Submission, user can see all responses count with Bar chart. - - ![React-Poll](./assets/react-poll.gif) - ![Webpart - 1 ](./assets/wp1.png) ![Webpart - 2 ](./assets/wp2.png) - - - **Following are some of the features of this component.** - - - - - These 2 lists will be provisioned automatically with necessary columns. - - - Poll Questions : User can add New poll question and their options. Also, user can set to keep it active or not. - - ![Poll Questions](./assets/poll-questions.png) - - - - - Poll Answers: This list will hold all Answers give by End users with his/her email id. - - ![Poll Answers](./assets/poll-answers.png) - - - Poll response can be viewed via Bar chart. - - - Easy to configure. - - ## Compatibility - - - - | :warning: Important | - - |:---------------------------| - - | Every SPFx version is optimally compatible with specific versions of Node.js. In order to be able to build this sample, you need to ensure that the version of Node on your workstation matches one of the versions listed in this section. This sample will not work on a different version of Node.| - - |Refer to for more information on SPFx compatibility. | - - - - This sample is optimally compatible with the following environment configuration: - - - - ![SPFx 1.17.1](https://img.shields.io/badge/SPFx-1.17.1-green.svg) - - ![Node.js v16.13+](https://img.shields.io/badge/Node.js-v16.13+-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://learn.microsoft.com/sharepoint/dev/spfx/sharepoint-framework-overview) - - - [Microsoft 365 tenant](https://learn.microsoft.com/sharepoint/dev/spfx/set-up-your-development-environment) - - - - > Get your own free development tenant by subscribing to [Microsoft 365 developer program](https://aka.ms/m365/devprogram) - - - - ## Prerequisites - - - - - Office 365 subscription with SharePoint Online - - - SharePoint Framework [development environment](https://learn.microsoft.com/sharepoint/dev/spfx/set-up-your-development-environment) set up - - - - ## Contributors - - - - - [Harsh Bhavsar](https://github.com/Harsh24491) - - - - ## Version history - - - - | Version | Date | Comments | - - - - | ------- | ---------------- | --------------- | - - - - | 1.0 | March 16, 2024 | Initial release | - - - - ## 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-poll) then unzip it) - - - From your command line, change your current directory to the directory containing this sample (`react-poll`, located under `samples`)* in the command line run: - +- `npm install` -- `npm install` - - - -- `gulp serve` - - - - +- `gulp serve` > 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](https://aka.ms/spfx-devcontainer) for further instructions. - - ## How to Set up Poll - - - - - This solution will provision 2 lists "Poll Questions" and "Poll Answers" - To set up new Poll navigate to "Poll Questions" from "Site Contents" @@ -259,61 +119,22 @@ This sample is optimally compatible with the following environment configuration - P.S. : Only 1 poll with Active will be displayed. - - - ## 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'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-pages-hierarchy%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-pages-hierarchy) 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-pages-hierarchy&template=bug-report.yml&sample=react-pages-hierarchy&authors=@bogeorge&title=react-pages-hierarchy%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-pages-hierarchy&template=question.yml&sample=react-pages-hierarchy&authors=@bogeorge&title=react-pages-hierarchy%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-pages-hierarchy&template=question.yml&sample=react-pages-hierarchy&authors=@bogeorge&title=react-pages-hierarchy%20-%20). - - - - ## [](https://github.com/pnp/sp-dev-fx-webparts/tree/main/samples/react-pages-hierarchy#disclaimer)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 +**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-poll/assets/sample.json b/samples/react-poll/assets/sample.json new file mode 100644 index 000000000..cc01e01c6 --- /dev/null +++ b/samples/react-poll/assets/sample.json @@ -0,0 +1,84 @@ +{ + "name": "pnp-sp-dev-spfx-web-parts-react-poll", + "source": "pnp", + "title": "Poll", + "shortDescription": "Add new poll questions and their options. End users can submit his/her response to the poll. After Submission, user can see all responses count with Bar chart.", + "url": "https://github.com/pnp/sp-dev-fx-webparts/tree/main/samples/react-poll", + "downloadUrl": "https://pnp.github.io/download-partial/?url=https://github.com/pnp/sp-dev-fx-webparts/tree/main/samples/react-poll", + "longDescription": [ + "Add new poll questions and their options. End users can submit his/her response to the poll. After Submission, user can see all responses count with Bar chart." + ], + "creationDateTime": "2024-03-16", + "updateDateTime": "2024-03-16", + "products": [ + "SharePoint" + ], + "metadata": [ + { + "key": "CLIENT-SIDE-DEV", + "value": "React" + }, + { + "key": "SPFX-VERSION", + "value": "1.17.1" + } + ], + "thumbnails": [ + { + "name": "react-poll.gif", + "type": "image", + "order": 100, + "url": "https://github.com/pnp/sp-dev-fx-webparts/raw/main/samples/react-poll/assets/D:\\GitHub\\pnp\\sp-dev-fx-webparts\\samples\\react-poll\\assets\\react-poll.gif", + "alt": "Web Part Preview" + }, + { + "name": "add-poll.png", + "type": "image", + "order": 101, + "url": "https://github.com/pnp/sp-dev-fx-webparts/raw/main/samples/react-poll/assets/D:\\GitHub\\pnp\\sp-dev-fx-webparts\\samples\\react-poll\\assets\\add-poll.png", + "alt": "Web Part Preview" + }, + { + "name": "poll-answers.png", + "type": "image", + "order": 102, + "url": "https://github.com/pnp/sp-dev-fx-webparts/raw/main/samples/react-poll/assets/D:\\GitHub\\pnp\\sp-dev-fx-webparts\\samples\\react-poll\\assets\\poll-answers.png", + "alt": "Web Part Preview" + }, + { + "name": "poll-questions.png", + "type": "image", + "order": 103, + "url": "https://github.com/pnp/sp-dev-fx-webparts/raw/main/samples/react-poll/assets/D:\\GitHub\\pnp\\sp-dev-fx-webparts\\samples\\react-poll\\assets\\poll-questions.png", + "alt": "Web Part Preview" + }, + { + "name": "wp1.png", + "type": "image", + "order": 104, + "url": "https://github.com/pnp/sp-dev-fx-webparts/raw/main/samples/react-poll/assets/D:\\GitHub\\pnp\\sp-dev-fx-webparts\\samples\\react-poll\\assets\\wp1.png", + "alt": "Web Part Preview" + }, + { + "name": "wp2.png", + "type": "image", + "order": 105, + "url": "https://github.com/pnp/sp-dev-fx-webparts/raw/main/samples/react-poll/assets/D:\\GitHub\\pnp\\sp-dev-fx-webparts\\samples\\react-poll\\assets\\wp2.png", + "alt": "Web Part Preview" + } + ], + "authors": [ + { + "gitHubAccount": "Harsh24491", + "pictureUrl": "https://github.com/Harsh24491.png", + "name": "Harsh Bhavsar" + } + ], + "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/sharepoint/dev/spfx/web-parts/get-started/build-a-hello-world-web-part" + } + ] +}