History

VesaJuvonen 3b6c5690ab readme polishing		2018-09-10 13:10:09 +03:00
..
asset-deployment-webpart	Add tslint at the root of each SPFx project (#394 )	2018-01-08 15:58:48 +02:00
documentcardexample-webpart	Add tslint at the root of each SPFx project (#394 )	2018-01-08 15:58:48 +02:00
hello-world-sp	Add tslint at the root of each SPFx project (#394 )	2018-01-08 15:58:48 +02:00
helloworld-webpart	Add tslint at the root of each SPFx project (#394 )	2018-01-08 15:58:48 +02:00
jquery-webpart	Add tslint at the root of each SPFx project (#394 )	2018-01-08 15:58:48 +02:00
README.md	readme polishing	2018-09-10 13:10:09 +03:00

README.md

Getting started with client-side web parts

Summary

This sub folders contains client-side projects includes the web parts detailed in the Getting Started walkthroughs. Technically these web parts could have remaind in one single solution, but to ensure that they match exactly what's in the tutorials, we have seperated them to dedicated solutions. Sub folders contains the following web parts:

Solution	Getting Started Walkthrough	Video
hello-world	Build your first web part	video
hello-world-sp	Connect your client-side web part to SharePoint	video
jquery-webpart	Add jQueryUI Accordion to your SharePoint client-side web part	video
documentcardexample-webpart	Use Office UI Fabric React components in your SharePoint client-side web part	video
asset-deployment-webpart	Provision SharePoint assets from SharePoint Framework solutions	TBD

You can also other SharePoint Framework releated videos from SharePoint PnP YouTube Channel.

Used SharePoint Framework Version

Applies to

Solution

Solution	Author(s)
web-part-tutorials	Microsoft SharePoint Framework Team

Version history

Version	Date	Comments
0.3.0	February 28th 2017	Updated to GA level.
0.2.0	February 15th 2017	Updated to RC0 level.
0.1.0	December 16th 2016	Updated to drop 6 level.
0.0.1	August 31st 2016	Initial release supporting SharePoint Framework developer preview.

Disclaimer

THIS CODE IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.

Build and run the tutorials

To build and run this client-side project, you will need to clone and build the tutorials project.

Clone this repo by executing the following command in your console:

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

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

cd sp-dev-fx-webparts

Navigate to the tutorials folder:

cd tutorials

Navigate to the specific web part folder:

cd 'subfolder'

Now run the following command to install the npm packages:

npm install

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

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

gulp serve