Set up your SharePoint Framework development environment

You can use Visual Studio or your own custom development environment to build SharePoint Framework solutions. You can use a Mac, PC, or Linux.

Note

Before following the steps in this article, be sure to Set up your Office 365 tenant.

You can also follow these steps by watching this video on the SharePoint PnP YouTube Channel:



Install developer tools

Install NodeJS

Install NodeJS LTS version.

  • If you are in Windows, you can use the msi installers in this link for the easiest way to set up NodeJS.
  • If you have NodeJS already installed, check that you have the latest version by using node -v. It should return the current LTS version.
  • If you are using a Mac, we recommend that you use homebrew to install and manage NodeJS.

Note

Current LTS version of NodeJS is 8.12.0. Notice that 9.x or 10.x versions are currently not supported with SharePoint Framework development.

Install a code editor

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

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

If you are using Ubuntu

You need to install compiler tools by using the following command:

sudo apt-get install build-essential

If you are using fedora

You need to install compiler tools by using the following command:

sudo yum install make automake gcc gcc-c++ kernel-devel

Install Yeoman and gulp

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 and gulp:

npm install -g yo gulp

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 -g @microsoft/generator-sharepoint

If you need to switch between the different projects created by using different versions of the SharePoint Framework Yeoman generator, you can install the generator locally as a development dependency in the project folder by executing the following command:

npm install @microsoft/generator-sharepoint --save-dev

For more information about the Yeoman SharePoint generator, see Scaffold projects by using Yeoman SharePoint generator.

Optional tools

Following are some tools that might come in handy as well:

Next steps

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

Note

If you find an issue in the documentation or in the SharePoint Framework, report that to SharePoint engineering by using the issue list at sp-dev-docs repository. Thanks for your input in advance.