Getting Started

These samples were created by the PnP community. They demonstrate different usage patterns for the SharePoint Framework client-side web parts.

The easiest way to get started with using these samples is to watch our video:

All samples are stored in a GitHub repository. Each sample is located in its own folder with a README.md file that provides details about what it demonstrates and any extra information to help you get the most out of it.

Using the samples

To build and start using these projects, you'll need to clone and build the projects.

Clone the SharePoint/sp-dev-fx-webparts repository by executing the following command in your console:

git clone https://github.com/SharePoint/sp-dev-fx-webparts.git

Navigate to the cloned repository folder which should be the same as the repository name:

cd sp-dev-fx-webparts

To access the samples use the following command, where you replace sample-folder-name with the name of the sample you want to access.

cd samples
cd sample-folder-name

and for the tutorials, use the following command:

cd tutorials

Now run the following command to install the npm packages:

npm install

This will install the required npm packages and dependencies to build and run the client-side project.

Once the npm packages are installed, run the following command to preview your web parts in SharePoint Workbench:

gulp serve