diff --git a/samples/react-find-parker/README.md b/samples/react-find-parker/README.md index 4bd84279f..328a45516 100644 --- a/samples/react-find-parker/README.md +++ b/samples/react-find-parker/README.md @@ -1,8 +1,8 @@ -# react-find-parker +# Find Parker ## Summary -Work is not about work ๐Ÿคจ, sometime a bit of fun is in order ๐Ÿ•น๏ธ. +Work is not about work ๐Ÿคจ, sometimes a bit of fun is in order ๐Ÿ•น๏ธ. This webpart is a simple find object game. ![parker](./assets/parker.gif) @@ -16,9 +16,16 @@ By changing the icon svg image we may create a find easter egg ๐Ÿฅš game or find or good old where's Wally game ๐Ÿ˜‰ ![findWally](./assets/findWally.png) -## Used SharePoint Framework Version -![version](https://img.shields.io/badge/version-1.13-green.svg) +## Compatibility + +![SPFx 1.13.0](https://img.shields.io/badge/SPFx-1.13.0-green.svg) +![Node.js v14 | v12 | v10](https://img.shields.io/badge/Node.js-v14%20%7C%20v12%20%7C%20v10-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 Partially](https://img.shields.io/badge/Hosted%20Workbench-Partially-yellow.svg "Will run on hosted workbench, but web part works better on a hosted page with content") ## Applies to @@ -30,7 +37,7 @@ or good old where's Wally game ๐Ÿ˜‰ Solution|Author(s) --------|--------- -react-find-parker | Adam Wojcik (https://github.com/Adam-it) +react-find-parker | [Adam Wojcik](https://github.com/Adam-it) ## Version history @@ -38,19 +45,13 @@ Version|Date|Comments -------|----|-------- 1.0|october 31, 2021|Halloween ๐ŸŽƒ๐ŸŽƒ๐ŸŽƒ & Initial release -## 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.** - ---- - ## Minimal Path to Awesome - Clone this repository - Ensure that you are at the solution folder - in the command-line run: - - **npm install** - - **gulp serve** + - `npm install` + - `gulp serve` ## Features @@ -61,4 +62,26 @@ This project contains sample client-side web parts built on the SharePoint Frame - [Getting started with SharePoint Framework](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/set-up-your-developer-tenant) - [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 \ No newline at end of file +- [Microsoft 365 Patterns and Practices](https://aka.ms/m365pnp) - Guidance, tooling, samples and open-source controls for your Microsoft 365 development + +## 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'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%3Areact-find-parker) 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=label%3Areact-find-parker) 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&template=bug-report.yml&sample=react-find-parker&authors=@Adam-it&title=react-find-parker%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=react-find-parker&authors=@Adam-it&title=react-find-parker%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=react-find-parker&authors=@Adam-it&title=react-find-parker%20-%20). + + \ No newline at end of file diff --git a/samples/react-find-parker/assets/sample.json b/samples/react-find-parker/assets/sample.json new file mode 100644 index 000000000..a227a1b40 --- /dev/null +++ b/samples/react-find-parker/assets/sample.json @@ -0,0 +1,51 @@ +[ + { + "name": "pnp-sp-dev-spfx-web-parts-react-find-parker", + "source": "pnp", + "title": "Find Parker", + "shortDescription": "This webpart is a simple find object game.", + "url": "https://github.com/pnp/sp-dev-fx-webparts/tree/main/samples/react-find-parker", + "longDescription": [ + "Work is not about work ๐Ÿคจ, sometimes a bit of fun is in order ๐Ÿ•น๏ธ", + "This webpart is a simple find object game." + ], + "creationDateTime": "2021-10-31", + "updateDateTime": "2021-10-31", + "products": [ + "SharePoint", + "Office" + ], + "metadata": [ + { + "key": "CLIENT-SIDE-DEV", + "value": "React" + }, + { + "key": "SPFX-VERSION", + "value": "1.13.0" + } + ], + "thumbnails": [ + { + "type": "image", + "order": 100, + "url": "https://github.com/pnp/sp-dev-fx-webparts/raw/main/samples/react-find-parker/assets/parker.gif", + "alt": "Find Parker" + } + ], + "authors": [ + { + "gitHubAccount": "Adam-it", + "pictureUrl": "https://github.com/Adam-it.png", + "name": "Adam Wojcik" + } + ], + "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" + } + ] + } +] \ No newline at end of file diff --git a/samples/react-find-parker/src/webparts/findParker/loc/en-us.js b/samples/react-find-parker/src/webparts/findParker/loc/en-us.js index 45dcf6e43..d846e43a3 100644 --- a/samples/react-find-parker/src/webparts/findParker/loc/en-us.js +++ b/samples/react-find-parker/src/webparts/findParker/loc/en-us.js @@ -8,7 +8,7 @@ define([], function() { "CouldNotFindPlaceForParkersDescription": "๐Ÿ™„ Your page seems strange, I don't see any playground to play here ๐Ÿ˜‰", "StartGameButton": "๐ŸŽฎ Start the game !", "RestartGameButton": "๐ŸŽฎ It was fun, lets try again", - "EndGameMessage": "Congrats! You are awasome ๐Ÿ‘๐Ÿ‘๐Ÿ‘", + "EndGameMessage": "Congrats! You are awesome ๐Ÿ‘๐Ÿ‘๐Ÿ‘", "GameProgressELementsLabel": "๐Ÿ” Elements to find: ", "GameProgressLabel": "๐Ÿ‘‰ You found: " }