honeymoose
/
sp-dev-fx-webparts
mirror of https://github.com/pnp/sp-dev-fx-webparts.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fixed readme

This commit is contained in:
Hugo Bernier 2020-11-04 23:13:31 -05:00
parent 176ca53f25
commit 4db979fc32
2 changed files with 77 additions and 17098 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

154
samples/react-word-game/README.md
View File

@ -1,77 +1,77 @@
# Word Game # Word Game
## Summary ## Summary
A fun game where you unscramble the words before the time runs out. It stores everyone's high scores in a SharePoint List on the Site. A fun game where you unscramble the words before the time runs out. It stores everyone's high scores in a SharePoint List on the Site.
![Word Game Preview](./assets/preview.gif) ![Word Game Preview](./assets/preview.gif)
## Used SharePoint Framework Version ## Used SharePoint Framework Version
![1.11.0](https://img.shields.io/badge/version-1.11.0-green.svg) ![1.11.0](https://img.shields.io/badge/version-1.11.0-green.svg)
## Applies to ## Applies to
* [SharePoint Framework](https://docs.microsoft.com/sharepoint/dev/spfx/sharepoint-framework-overview) * [SharePoint Framework](https://docs.microsoft.com/sharepoint/dev/spfx/sharepoint-framework-overview)
* [Office 365 tenant](https://docs.microsoft.com/sharepoint/dev/spfx/set-up-your-development-environment) * [Office 365 tenant](https://docs.microsoft.com/sharepoint/dev/spfx/set-up-your-development-environment)
## Prerequisites ## Prerequisites
- SharePoint Online Tenant or SharePoint 2019 On Prem - SharePoint Online Tenant or SharePoint 2019 On Prem
## Solution ## Solution
Solution|Author(s) Solution|Author(s)
--------|--------- --------|---------
react-word-game | Neil Barkhina ([www.neilb.net](https://www.neilb.net/)) react-word-game | Neil Barkhina ([www.neilb.net](https://www.neilb.net/))
react-word-game | Don Kirkham ([@DonKirkham](https://twitter.com/DonKirkham/)) react-word-game | Don Kirkham ([@DonKirkham](https://twitter.com/DonKirkham/))
## Version history ## Version history
Version|Date|Comments Version|Date|Comments
-------|----|-------- -------|----|--------
1.0|May 27, 2020|Initial release 1.0|May 27, 2020|Initial release
2.0|Nov 4, 2020|Upgrade to SPFx v1.11.0 (Don Kirkham) 2.0|Nov 4, 2020|Upgrade to SPFx v1.11.0 (Don Kirkham)
## 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.** **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 ## Minimal Path to Awesome
* Clone this repository * Clone this repository
* In the command line run: * In the command line run:
* `npm install` * `npm install`
* `gulp serve` * `gulp serve`
* If you haven't trusted your dev cert yet run * If you haven't trusted your dev cert yet run
* `gulp trust-dev-cert` * `gulp trust-dev-cert`
* To Deploy it in your SharePoint Environment * To Deploy it in your SharePoint Environment
* `gulp --ship` * `gulp --ship`
* `gulp package-solution --ship` * `gulp package-solution --ship`
* Upload the .sppkg file from sharepoint\solution folder into your App Catalog * Upload the `.sppkg` file from the `sharepoint\solution` folder into your App Catalog
## Features ## Features
This demonstrates how you can create a fun game to play with your SharePoint peers. It was built using React and also uses jQuery to help load the Word List. It demonstrates these features: This demonstrates how you can create a fun game to play with your SharePoint peers. It was built using React and also uses jQuery to help load the Word List. It demonstrates these features:
- SharePoint REST API's - SharePoint REST API's
- Creating List and List Items API - Creating List and List Items API
- Creating columns in a SharePoint List - Creating columns in a SharePoint List
- Web Part Property Pane Settings - Web Part Property Pane Settings
- CSS Styling and Animations - CSS Styling and Animations
- Fun and engaging UX - Fun and engaging UX
- Responsive Design - Responsive Design
If you want to disable the high scores feature you can edit the Web Part Settings. The Web Part stores the high scores in a SharePoint List that it creates called WordGameList. You can also change the Game Title in the settings: If you want to disable the high scores feature you can edit the Web Part Settings. The Web Part stores the high scores in a SharePoint List that it creates called WordGameList. You can also change the Game Title in the settings:
![Settings](./assets/settings.PNG) ![Settings](./assets/settings.PNG)
It also uses responsive design which works great on the SharePoint Mobile App: It also uses responsive design which works great on the SharePoint Mobile App:
![Mobile](./assets/wordgame_mobile.png) ![Mobile](./assets/wordgame_mobile.png)
<img src="https://telemetry.sharepointpnp.com/sp-dev-fx-webparts/samples/react-word-game" /> <img src="https://telemetry.sharepointpnp.com/sp-dev-fx-webparts/samples/react-word-game" />

17021
samples/react-word-game/package-lock.json generated
View File

File diff suppressed because it is too large Load Diff