Setup your machine

The SharePoint Framework is currently in Preview, and is subject to change based on customer feedback. While we’re in preview, SharePoint Framework web parts are not supported for use in production environments.

In order to successfully complete the tutorials, you will need to setup your Mac or PC with the right tools.

Mac or PC or Linux

You can use a Mac or PC or Linux to complete the tutorials.

Install Dev Tools

• NodeJS Long Term Support (LTS) version

  • If you have NodeJS already installed please check you have the latest version using node -v. It should return the current LTS version.
  • If you are using a Mac, it is recommended you use homebrew to install and manage NodeJS.

• Visual Studio Code

If you are using a PC

You need to install a couple more things - Visual Studio and Python.

• If you are using Visual Studio:

  • Visual Studio 2015
  • Latest Visual Studio 2015 Update
    • Visual Studio Update 3
  • NodeJS Tools for Visual Studio

• Python 2.7.x

If you are using Ubuntu

You need to install compiler tools using the following command:

sudo apt-get build-essential

If you are using fedora

You need to install compiler tools using the following command:

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

Here are some tools that might come in handy as well.

• Optional Tools:
  • Fiddler
  • Postman plugin for Chrome
  • Cmder for Windows
  • Oh My Zsh for Mac

Install Yeoman and Gulp

Now that you have setup your dev environment, it is time to install Yeoman. Yeoman helps you to kick start new projects, prescribing best practices and tools to help you stay productive.

SharePoint client-side development tools includes a yeoman generator for creating new webparts and reference:

• Common build tools
• Common boilerplate code to help build webparts (base libraries)
• Common playground web site to host their webparts for testing purposes

Use the following console command to install Yeoman and Gulp:

npm i -g yo gulp

Install Yeoman SharePoint Generator

The Yeoman SharePoint WebPart generator lets you to quickly create a SharePoint client-side solution projects with the right tool chain and project structure.

Use the following console command to install SharePoint generator:

npm i -g @microsoft/generator-sharepoint 

Next steps

You are all set now to build SharePoint client-side solutions!