sp-dev-fx-webparts/samples/react-environment-settings

SPFx environment settings management

Summary

Disclaimer: This is as much of a script sample as a SPFx Web Part sample.

When building SPFx solutions, a very common need is to have different settings for different environments.

Up until now I hadn't come across a good solution, that was until I came across this awesome comment from Beau Cameron, after asking his permission I have turned his comment into a sample.

The main idea is that you can create as many environment as you want, simply add a "settings.<name>.json" file in the settings folder.

Using the scripts in the Scripts.ps1 file you can easily setup your existing SPFx solutions to use this concept, and use the Set-SPFxEnvironment -Environment <name> command to switch between environments.

Compatibility

⚠️ 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 optimally compatible with the following environment configuration:

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

Applies to

• SharePoint Framework
• Microsoft 365 tenant

Get your own free development tenant by subscribing to Microsoft 365 developer program

Contributors

• Dan Toft

Version history

Version	Date	Comments
1.0	November 14, 2023	Initial release

Prerequisites

Experience with SPFx web parts

Minimal path to awesome

• Clone this repository (or download this solution as a .ZIP file then unzip it)
• From your command line, change your current directory to the directory containing this sample (react-environment-settings, located under samples)
• in the command line run:
  • npm install
  • gulp serve

This sample can also be opened with VS Code Remote Development. Visit https://aka.ms/spfx-devcontainer for further instructions.

Features

• Manage your tenant wide extensions
• Easily enable/disable extensions
• Easily update the extension properties

Help

We do not support samples, but 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 from within the solution folder to diagnose incompatibility issues with your environment.

You can try looking at issues related to this sample to see if anybody else is having the same issues.

You can also try looking at discussions related to this sample and see what the community is saying.

If you encounter any issues using this sample, create a new issue.

For questions regarding this sample, create a new question.

Finally, if you have an idea for improvement, make a suggestion.

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.