sp-dev-fx-webparts/tutorials
Vesa Juvonen b240aad561 Updated sample to new structure. Updates on the repo readme with resource links. 2016-08-31 17:14:32 +03:00
..
.vscode Initial release: tutorials folder contains web part getting started walkthroughs. 2016-08-30 22:56:07 -07:00
config Initial release: tutorials folder contains web part getting started walkthroughs. 2016-08-30 22:56:07 -07:00
src Initial release: tutorials folder contains web part getting started walkthroughs. 2016-08-30 22:56:07 -07:00
typings Initial release: tutorials folder contains web part getting started walkthroughs. 2016-08-30 22:56:07 -07:00
.editorconfig Initial release: tutorials folder contains web part getting started walkthroughs. 2016-08-30 22:56:07 -07:00
.gitattributes Initial release: tutorials folder contains web part getting started walkthroughs. 2016-08-30 22:56:07 -07:00
.gitignore Initial release: tutorials folder contains web part getting started walkthroughs. 2016-08-30 22:56:07 -07:00
.npmignore Initial release: tutorials folder contains web part getting started walkthroughs. 2016-08-30 22:56:07 -07:00
README.md Updated sample to new structure. Updates on the repo readme with resource links. 2016-08-31 17:14:32 +03:00
gulpfile.js Initial release: tutorials folder contains web part getting started walkthroughs. 2016-08-30 22:56:07 -07:00
package.json Initial release: tutorials folder contains web part getting started walkthroughs. 2016-08-30 22:56:07 -07:00
tsconfig.json Initial release: tutorials folder contains web part getting started walkthroughs. 2016-08-30 22:56:07 -07:00
tsd.json Initial release: tutorials folder contains web part getting started walkthroughs. 2016-08-30 22:56:07 -07:00

README.md

Getting started with client-side web parts

Summary

This web-part-tutorials client-side project includes the web parts detailed in the Getting Started walkthroughs. The solution contains the following web parts:

Web part Getting Started Walkthrough
helloWorld Build your first web part
helloWorldSharePoint Connect your client-side web part to SharePoint
jQuery Add jQueryUI Accordion to your SharePoint client-side web part
documentCardExample Use Office UI Fabric React components in your SharePoint client-side web part

Applies to

Solution

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

Version history

Version Date Comments
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

Now run the following command to install the npm packages:

npm i

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