Setup Office 365 tenant
- Create App Catalog: We need App Catalog to upload and deploy web parts.
- Create Developer Site: SharePoint Site Collection or site to test the web part.
- Workbench: It is a developer design surface that enables you to quickly preview and test web parts without deploying them in SharePoint. SharePoint workbench can be accessed from any SharePoint site in your tenancy using following URL:
https://your-sharepoint-site/_layouts/workbench.aspx
Setup development environment
- Install a code editor
- You can use any code editor or IDE that supports client side web part development such as Visual Studio Code, Atom or Webstorm.
- Install NodeJs (The current supported LTS version of NodeJS for the SharePoint Framework is both 8.x and 10.x. Notice that 9.x , 11.x and 12.x versions are currently NOT supported with SharePoint Framework development).
- At this time, Node.js v12.x is the Active LTS version listed on the Node.js homepage as the default download. To download Node.js v10.x, use the Node.js > Downloads > Previous Releases page.
- For SharePoint Server 2016, recommended version of Node is 8.x.x
- For SharePoint Server 2019 and SharePoint Online it is 10.x.x
- My Node version is 10.16.0 and gulp version is 3.9.1
- Install Yeoman and Gulp.
- These are the packages from NPM package manager and are basically tools which we use for SharePoint Framework development.
- Yeoman is an open source client-side scaffolding tool for web applications. Yeoman runs as a command-line interface written for Node.js and combines several functions into one place, such as generating a starter template, managing dependencies, running unit tests, providing a local development server, and optimizing production code for deployment.
- Gulp is a cross-platform, streaming task manager that lets developers automate many development tasks.
- Once you install NodeJs, open Command Prompt and type the following command.
npm install -g yo npm install -g gulp
- Install Yeoman SharePoint Generator
- It help you to quickly create a SharePoint client-side solution project with the right toolchain and project structure. Enter the following command to install it.
npm install -g @microsoft/generator-sharepoint
- It help you to quickly create a SharePoint client-side solution project with the right toolchain and project structure. Enter the following command to install it.

