Set up your SharePoint Framework development environment

You can use any text editor to build SharePoint Framework (SPFx) solutions. You can use a macOS, Windows, or Linux environment as well.

Install Node.js

Install the most recent LTS version of Node.js v22.

This version is the recommended version of Node.js to use with the SPFx v1.22.*. If you are using a different version of SPFx, verify you install a version of Node.js that's supported by that version of SPFx.

You can check if you already have Node.js installed, including the installed version, by running the following command:

node --version

The SharePoint Framework v1.22.* is supported on Node.js v22 LTS (aka Jod).

Install a code editor

You can use any code editor or IDE that supports client-side development to build your web part, such as:

• Visual Studio Code
• Webstorm

The steps and examples in this documentation use Visual Studio Code, but you can use any editor of your choice.

Install development toolchain prerequisites

The SharePoint Framework development and build toolchain leverages various popular open-source tools. While most dependencies are included in each project, you need to install a few dependencies globally on your workstation.

npm install @rushstack/heft yo @microsoft/generator-sharepoint --global

Install Heft

Heft is a config-driven toolchain that invokes other popular tools like TypeScript, ESLint, Jest, Webpack, and API Extractor to build web applications, Node.js services, command-line tools, and libraries. It's designed for use in monorepos with potentially hundreds of projects, where it's typically launched by package.json commands like npm run build or npm run test. If you're familiar with build tools like Vite, esbuild, or task runners like Gulp or Grunt, Heft plays a similar role but with a focus on large-scale consistency.

Learn more about the Heft-based toolchain in SharePoint Framework Toolchain: Heft & Webpack.

Enter the following command to install the Heft CLI globally:

npm install @rushstack/heft --global

Install Yeoman

Yeoman helps you kick-start new projects, and prescribes best practices and tools to help you stay productive. SharePoint client-side development tools include a Yeoman generator for creating new web parts. The generator provides common build tools, common boilerplate code, and a common playground website to host web parts for testing.

Enter the following command to install Yeoman:

npm install yo --global

Install Yeoman SharePoint generator

The Yeoman SharePoint web part generator helps you quickly create a SharePoint client-side solution project with the right toolchain and project structure.

To install the SharePoint Framework Yeoman generator globally, enter the following command:

npm install @microsoft/generator-sharepoint --global

For more information about the Yeoman SharePoint generator, see Yeoman generator for the SharePoint Framework.

Install a modern web browser

You should be using a modern web browser like Microsoft Edge, Google Chrome, or Firefox as the development browser.

Trusting the self-signed developer certificate

The SharePoint Framework's local web server, used when testing your custom solutions from your development environment, uses HTTPS by default. This is implemented using a development self-signed SSL certificate. Self-signed SSL certificates are not trusted by your developer environment. You must first configure your development environment to trust the certificate.

A utility command is included in every SharePoint Framework project in the form of a Heft command. You can elect to do this now, or wait until you create your first project as covered in the Build your first SharePoint client-side web part (Hello World part 1) tutorial.

Once a project has been created with the Yeoman generator for the SharePoint Framework, execute the following command from within the root folder of the project.

heft trust-dev-cert

Set the SPFX_SERVE_TENANT_DOMAIN environment variable (optional)

Starting with SPFx v1.17, Microsoft replaced the hosted workbench URL launched when you execute gulp serve with a dynamic value. This is defined in the project's ./config/serve.json file in the initialPage property:

{
  "$schema": "https://developer.microsoft.com/json-schemas/spfx-build/spfx-serve.schema.json",
  "port": 4321,
  "https": true,
  "initialPage": "https://{tenantDomain}/_layouts/workbench.aspx"
}

The SPFx build toolchain will replace this value on the fly with a value defined in an environment variable on your local workstation.

Developers can use the SPFX_SERVE_TENANT_DOMAIN OS environment variable to specify the tenant domain (or site URL) for serve configurations across different SPFx solutions. If a URL in the serve configuration (for example, pageUrl for Field Customizer) contains the {tenantDomain} placeholder, it will be automatically replaced with the variable's value.

For more information on how to set the environment variable on your developer environment, including Windows or macOS, see Setting the SharePoint Framework Hosted Workbench Test Site.

Optional tools

While not required for SPFx development, you may also find the following tools useful:

• Fiddler
• Postman
• Windows Terminal
• Cmder for Windows
• Oh My Zsh
• Git source control tools
• Microsoft 365 Agents Toolkit VS Code extension
• SharePoint Framework Toolkit VS Code extension

Next steps

You're now ready to build your first client-side web part!

Managing multiple development environments

Depending on your scenario, you may need to maintain different development environments. Developers have used the following approaches to address these challenges:

• virtual machines
• Docker
• Node version managers

Troubleshooting

Check the version of globally installed packages

To get a list of all globally installed packages, run the following command:

npm list --global

Unable to Trust the Self-signed Development Certificate

If you're having trouble trusting your self-signed certificate when you run heft trust-dev-cert & you've verified that the correct versions of all dependencies are installed, one solution we usually see resolve the issue is to uninstall all globally installed packages, uninstall Node.js, reboot & start again.

In some cases, executing the command heft trust-dev-cert, doesn't have the wanted effect of trusting the self-signed development certificate on your machine. In rare cases such as these, you may need to delete a hidden folder that's generated in your profile folder.

Locate and delete folder {{homedir}}/.rushstack then try to trust the self-signed development certificate again. Otherwise running heft untrust-dev-cert will have same effect to remove the certificate files from the profile folder.

In case the certificate is not added to the Trusted Root Certification Authority despite running heft trust-dev-cert because of some policies blocking the action, the rushstack-serve.pem file from {{homedir}}/.rushstack folder can be imported manually into the Certificate Manager under Trusted Root Certification Authority with a local admin account.

Unable to Install Packages with npm - Corporate Proxies

If your development environment is behind a corporate proxy, you need to configure npm to use that proxy. Refer to the npm-config documents on how to configure your development environment behind a corporate proxy... specifically the proxy & http-proxy settings. More information: Configure npm for a corporate web proxy

See also

• SharePoint Framework Toolchain: Heft & Webpack
• SharePoint Framework Legacy Toolchain: Gulp & Webpack
• Set up your SharePoint Framework Gulp-Based development environment
• SharePoint Framework development tools and libraries compatibility
• SharePoint Framework development with SharePoint Server 2016 Feature Pack 2
• SharePoint Framework development with SharePoint Server 2019 and Subscription Edition