Open-source generator to extend the capabilities of the Microsoft SPFx generator
Clone or download
StfBauer Update documentation images
Update yo-running image

package.json version
Latest commit bf51532 Nov 13, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Pre-Angular merge (#110) Nov 1, 2018
.github Update issue_template.md Sep 22, 2018
app Pre-Angular merge (#110) Nov 1, 2018
docs Update documentation images Nov 12, 2018
generators Update package dependencies Nov 10, 2018
lib Update pnpsays.js Nov 1, 2018
test Pre-Angular merge (#110) Nov 1, 2018
tools Update package dependencies Nov 10, 2018
.editorconfig added circleci tests# Aug 18, 2018
.gitignore Update documentation Aug 14, 2018
LICENSE Initial commit May 29, 2018
README.md PnP/SPFx Generator Version 1.4 Nov 1, 2018
mkdocs.yml Dev (#115) Nov 6, 2018
package-lock.json 1.4.3 Nov 12, 2018
package.json 1.4.3 Nov 12, 2018

README.md

@pnp/generator-spfx

This is an open-source extension for native out of the box SPFx generator to introduce additional scaffolding support for Angular Elements, VueJS, Handlebars and many more in future. This generator has a dependency on native SPFx generator from Microsoft.

PnP SPFx Generator

Work is in progress and we'll absolutely accept contributions after the initial version is available.

Current Supported Frameworks and Add-ons

Add-on

The following add-on are supported:

Library Version Generators
jQuery 2.x, 3.x All
@pnp/pnpjs > 1.4. All
@pnp/spfx-property-controls 1.10.0 All
@pnp/spfx-controls-react 1.8.0 ReactJS

Frameworks

The following frameworks are supported:

Framework Version
Handlebars > 4.0.0
VueJS > 2.5.16
Angular Elements > 7.0.2

Usage

Install the generator:

npm install -g @pnp/generator-spfx

To start your first project using this generator:

yo @pnp/spfx

We will guide you through the your project creation.

Follow the  on screen

Installation for Development

The PnP Community generator is currently only available through the following method.

git clone https://github.com/pnp/generator-spfx.git

Install all required packages:

npm install

Start coding ...

More details on our documentation

SharePoint Patterns and Practices

Sharing is caring!