honeymoose
/
sp-dev-fx-webparts
mirror of https://github.com/pnp/sp-dev-fx-webparts.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
sp-dev-fx-webparts/tutorials/tutorial-getting-started
History
Hugo Bernier 7202809a7d Changed docs links to learn 2022-10-24 09:42:45 -04:00
..
asset-deployment-webpart Web parts is written with two words. 2021-11-21 03:00:49 -05:00
documentcardexample-webpart URL dev.office.com to docs.microsoft.com 2020-06-09 09:09:22 +02:00
hello-world-sp Web parts is written with two words. 2021-11-21 03:00:49 -05:00
helloworld-webpart Web parts is written with two words. 2021-11-21 03:00:49 -05:00
jquery-webpart Web parts is written with two words. 2021-11-21 03:00:49 -05:00
README.md Changed docs links to learn 2022-10-24 09:42:45 -04:00

README.md

Getting started with client-side web parts

Summary

This sub folder contains client-side projects includes the web parts detailed in the Getting Started walkthroughs. Technically these web parts could have remained in one single solution, but to ensure that they match exactly what's in the tutorials, we have separated 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 find other SharePoint Framework related videos from the SharePoint PnP YouTube Channel.

Used SharePoint Framework Version

GA

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/pnp/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 dependencies 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