sp-dev-fx-webparts/samples/react-upgrade-me/README.md

# Upgrade Me

## Summary

This web part does nothing, really. It is intended to be used to test upgrading SPFx web parts and demonstrating incompatibility issues between versions of SPFx and Node.js.

![picture of the web part in action saying 'This web part does nothing'](./assets/react-upgrade-me.png)


## Compatibility

| :warning: Important          |
|:---------------------------|
| Every SPFx version is only compatible with specific version(s) of Node.js. In order to be able to build this sample, please 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 <https://aka.ms/spfx-matrix> for more information on SPFx compatibility.   |

This sample is designed to be used in the following environments:

![SPFx 1.4.1](https://img.shields.io/badge/SPFx-1.4.1-green.svg "SPFx 1.4.1 works with SharePoint 2019 and SharePoint Online") 
![Node.js v6 | v8](https://img.shields.io/badge/Node.js-LTS%206.x%20%7C%20v8-green.svg "Node.js v6 or v8 is required to run SPFx 1.4.1")
![SharePoint 2019 | Online - It won't work with SharePoint 2016](https://img.shields.io/badge/SharePoint-2019%20%7C%20Online-yellow.svg "It won't work on SharePoint 2016")
![Teams Not compatible - Don't waste your time](https://img.shields.io/badge/Teams-Not%20compatible-red.svg "Don't waste your time")
![Workbench Local | Hosted - It works on my machine, and yours, and in the cloud](https://img.shields.io/badge/Workbench-Local%20%7C%20Hosted-green.svg "It works on my machine, your machine, and in the cloud")
![Compatible with Remote Containers](https://img.shields.io/badge/Remote%20Containers-Compatible-green.svg)


For more information about SPFx compatibility, please refer to https://aka.ms/spfx-matrix


## 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)


## Prerequisites

You'll need the [CLI for Microsoft 365](https://pnp.github.io/cli-microsoft365/) in order to perform an upgrade.

## Contributors

* [Hugo Bernier](https://github.com/hugoabernier)

## Version history

Version|Date|Comments
-------|----|--------
1.0|August 26, 2020|Initial release


## Minimal Path to Awesome

Download this [as a Zip file](https://pnp.github.io/download-partial/?url=https://github.com/pnp/sp-dev-fx-webparts/tree/main/samples/react-upgrade-me)

>  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.


## Features

This web part really does nothing. It is intended to be used with the CLI for Microsoft 365 [SPFx Project Upgrade](https://pnp.github.io/cli-microsoft365/cmd/spfx/project/project-upgrade/).


## 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.**
<img src="https://m365-visitor-stats.azurewebsites.net/sp-dev-fx-webparts/samples/react-upgrade-me" />
Initial version 2020-08-27 00:12:13 -04:00			`# Upgrade Me`
Test image 2023-04-11 10:20:13 -04:00
Initial version 2020-08-27 00:12:13 -04:00			`## Summary`

			`This web part does nothing, really. It is intended to be used to test upgrading SPFx web parts and demonstrating incompatibility issues between versions of SPFx and Node.js.`

Update README.md 2021-04-08 12:13:59 -04:00			`![picture of the web part in action saying 'This web part does nothing'](./assets/react-upgrade-me.png)`
Initial version 2020-08-27 00:12:13 -04:00

Update README.md Added compatibility info 2021-01-13 18:56:21 -05:00			`## Compatibility`

Added compatibility warning on readme and template 2023-02-10 10:22:32 -05:00			`\| :warning: Important \|`
			`\|:---------------------------\|`
			`\| Every SPFx version is only compatible with specific version(s) of Node.js. In order to be able to build this sample, please 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 <https://aka.ms/spfx-matrix> for more information on SPFx compatibility. \|`

			`This sample is designed to be used in the following environments:`
Added links to compatibility matrix 2022-10-17 10:21:52 -04:00
Update README.md 2021-04-08 12:13:13 -04:00			`![SPFx 1.4.1](https://img.shields.io/badge/SPFx-1.4.1-green.svg "SPFx 1.4.1 works with SharePoint 2019 and SharePoint Online")`
Removed reference to LTS 2021-11-01 21:07:49 -04:00			`![Node.js v6 \| v8](https://img.shields.io/badge/Node.js-LTS%206.x%20%7C%20v8-green.svg "Node.js v6 or v8 is required to run SPFx 1.4.1")`
Update README.md 2021-04-08 12:13:13 -04:00			`![SharePoint 2019 \| Online - It won't work with SharePoint 2016](https://img.shields.io/badge/SharePoint-2019%20%7C%20Online-yellow.svg "It won't work on SharePoint 2016")`
			`![Teams Not compatible - Don't waste your time](https://img.shields.io/badge/Teams-Not%20compatible-red.svg "Don't waste your time")`
			`![Workbench Local \| Hosted - It works on my machine, and yours, and in the cloud](https://img.shields.io/badge/Workbench-Local%20%7C%20Hosted-green.svg "It works on my machine, your machine, and in the cloud")`
Added 1.4.1 containers 2022-02-16 20:46:49 -05:00			`![Compatible with Remote Containers](https://img.shields.io/badge/Remote%20Containers-Compatible-green.svg)`
Update README.md Added compatibility info 2021-01-13 18:56:21 -05:00
Initial version 2020-08-27 00:12:13 -04:00
Added links to compatibility matrix 2022-10-17 10:21:52 -04:00			`For more information about SPFx compatibility, please refer to https://aka.ms/spfx-matrix`


Initial version 2020-08-27 00:12:13 -04:00			`## Applies to`

Changed docs links to learn 2022-10-24 09:42:45 -04:00			`* [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)`
Initial version 2020-08-27 00:12:13 -04:00

			`## Prerequisites`

			`You'll need the [CLI for Microsoft 365](https://pnp.github.io/cli-microsoft365/) in order to perform an upgrade.`

Changed authors to contributors 2023-02-18 22:58:44 -05:00			`## Contributors`
Initial version 2020-08-27 00:12:13 -04:00
Added more contributions 2023-03-15 01:23:34 -04:00			`* [Hugo Bernier](https://github.com/hugoabernier)`
Initial version 2020-08-27 00:12:13 -04:00
			`## Version history`

			`Version\|Date\|Comments`
			`-------\|----\|--------`
			`1.0\|August 26, 2020\|Initial release`


			`## Minimal Path to Awesome`

Added zip file 2021-12-06 14:09:37 -05:00			`Download this [as a Zip file](https://pnp.github.io/download-partial/?url=https://github.com/pnp/sp-dev-fx-webparts/tree/main/samples/react-upgrade-me)`
Initial version 2020-08-27 00:12:13 -04:00
Added 1.4.1 containers 2022-02-16 20:46:49 -05:00			`> 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.`

Initial version 2020-08-27 00:12:13 -04:00
			`## Features`

			`This web part really does nothing. It is intended to be used with the CLI for Microsoft 365 [SPFx Project Upgrade](https://pnp.github.io/cli-microsoft365/cmd/spfx/project/project-upgrade/).`

Moved disclaimers to bottom 2021-11-07 01:54:14 -05: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.**`
Updated telemetry link 2023-03-12 21:16:15 -04:00			`<img src="https://m365-visitor-stats.azurewebsites.net/sp-dev-fx-webparts/samples/react-upgrade-me" />`