From 57430827eba1aab4d1fc1caa503c3e9f3d9f5f55 Mon Sep 17 00:00:00 2001 From: Mun Ghaleb <1282376+mghaleb@users.noreply.github.com> Date: Tue, 31 Oct 2023 14:59:51 +0000 Subject: [PATCH 1/2] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7a24e4b23..cc25cc910 100644 --- a/README.md +++ b/README.md @@ -84,7 +84,7 @@ Once the npm packages are installed, run the following command to preview your w gulp serve ``` -## Authors +## Authors This repository's contributors are all community members who volunteered their time to share code samples. Work is done as an open source community project, with each sample contained in their own solution. ## Contributions @@ -97,4 +97,4 @@ Please have a look on our [Contribution Guidance](./CONTRIBUTING.md) before subm This repository has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. > Sharing is caring! - \ No newline at end of file + From 0554dc9f3bacbabf6c1de1c059c2145c37fab4e2 Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 4 Nov 2023 11:59:21 -0400 Subject: [PATCH 2/2] Added nvs/nvm instructions --- README.md | 37 ++++++++++++++++++------------------- 1 file changed, 18 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index cc25cc910..9ade3f4e6 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,3 @@ - # SharePoint Framework Client-Side Web Part Samples & Tutorial Materials ![GitHub Repo stars](https://img.shields.io/github/stars/pnp/sp-dev-fx-webparts?style=social) @@ -64,13 +50,24 @@ cd samples cd sample-folder-name ``` -and for the tutorials, use the following command: +Ensure that you are using the right version of node for the solution. You can do so by consulting the `README.md` file in the sample folder you are interested in. You will see a node version recommendation; you can also consult the SPFx Compatibility Matrix at to find the supported versions of node for the version of SPFx used by the sample. + +The sample folder may also contain a `.nvmrc` file, which is a version specifier that can be used with a node version manager such as [nvm](https://github.com/coreybutler/nvm-windows) or [nvs](https://github.com/jasongin/nvs), ensure that you are using the right version of node for the project. + +To switch to the correct version of node using nvm, run the following command in the folder containing the `.nvmrc` file: ```shell -cd tutorials +nvm use ``` -Now run the following command to install the npm packages: +If using nvs, run the following command in the folder containing the `.nvmrc` file: + +```shell +nvs use +``` + +Once the correct version of node is in use, run the following command to install the npm packages: + ```shell npm install @@ -84,16 +81,18 @@ Once the npm packages are installed, run the following command to preview your w gulp serve ``` -## Authors +## Authors + This repository's contributors are all community members who volunteered their time to share code samples. Work is done as an open source community project, with each sample contained in their own solution. ## Contributions -These samples are direct from the feature teams, SharePoint PnP core team (http://aka.ms/m365pnp) or shared by the community. We welcome your input on issues and suggestions for new samples. We do also welcome community contributions around the client-side web parts. If you have any questions, just let us know. +These samples are direct from the feature teams, SharePoint PnP core team () or shared by the community. We welcome your input on issues and suggestions for new samples. We do also welcome community contributions around the client-side web parts. If you have any questions, just let us know. Please have a look on our [Contribution Guidance](./CONTRIBUTING.md) before submitting your pull requests, so that we can get your contribution processed as fast as possible. ## Code of Conduct + This repository has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. > Sharing is caring!