Set up your SharePoint client-side web part environment

Suggested Topics

 

What is SharePoint Framework (SPFx)

Future prospects of SharePoint Framework (SPFx)

Required tools and libraries for SharePoint Framework (SPFx) development

Setup Office 365 tenant for SharePoint Framework development

We have already performed various tasks to understand and setup environment for SharePoint framework development. Above mentioned suggested topics are providing references to those articles.

In this article, I’ll describe about setting up development environment for SharePoint Online customization using SharePoint Framework SPFx. Let’s complete it step by step.

 



 

Install development tools

 

Node.JS

Install Node.JS Long Term Support (LTS) version from https://nodejs.org/en/ and make sure that you have latest LTS Version of Node.JS. You can see it at https://nodejs.org/en/download/

You can see installed version on your machine by running following command

node -v

After installing Node, you have to update it by running following command in command prompt

npm install -g npm

setup-spfx-1

 



 

Code Editors

Following is a list of editors which supports client-side development to build your web part, we can use anyone of these.

  1. Visual Studio Code
  2. Atom
  3. Webstorm

 

I have used Visual Studio Code in my environment.

 



 

Install Yeoman and gulp

Yeoman helps to kick-start new projects and suggests best practices and tools to keep us productive. SharePoint client side development tools include Yeoman generator for creating new web parts. It provides common building tools, code and web site to host web parts for testing.

You can run following command to install Yeoman and gulp.

npm install –g yo gulp

 

setup-spfx-2

 

You can see that few packages are deprecated which can be upgraded later as well.

 



 

Install Yeoman SharePoint generator

Yeoman SharePoint web part generator is used to create SharePoint client side solution project with right toolchain and project structure.

You can install it using following command

npm install -g @microsoft/generator-sharepoint

 

setup-spfx-3

 

Yeoman generator for SharePoint is deployed globally with initial General Availability (GA) version. There are some known issue if it is installed locally to the project which will be resolved in next releases of GA.

 



 

Optional tools

Some of the optional tools are listed below:

  1. Fiddler
  2. Postman plugin for Google Chrome
  3. Cmder for Windows
  4. Oh My Zsh for Mac
  5. Git Source Code tools

However, I have not installed any optional tool as of now. I’ll install it as and when needed.

 



 

What’s next

 

You are now ready to start with first client side web part.

In next article, I’ll demonstrate, building first hello world client side web part.

 



 

About Satyendra Mishra

Satyendra is a Technical Project Manager with 12+ years of experience on Project Management, Microsoft Technologies including ASP.NET, ASP.NET MVC, C#, SharePoint (On premises & Office 365), JavaScript Framework (AngularJS) and related technologies. He is a person with belief, sky is limit for a hard working and dedicated individual. That’s why he devoted himself to field of Software Development and now both are growing with each other. Every year for him turned out to be best year and he received enormous support and love from his companies and his clients from around the world. Now with vast knowledge of software development and its outsourcing process, he decided to move himself into knowledge sharing. Keep a fact in your mind about the comfort level of your clients and this will make you king/queen of your area.
View all posts by Satyendra Mishra →

Leave a Reply

Your email address will not be published. Required fields are marked *