{"id":1763,"date":"2018-09-13T13:22:34","date_gmt":"2018-09-13T13:22:34","guid":{"rendered":"https:\/\/developer.microsoft.com\/en-us\/office\/blogs\/?p=1763"},"modified":"2018-09-13T13:22:34","modified_gmt":"2018-09-13T13:22:34","slug":"introducing-open-source-pnp-spfx-yeoman-generator","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/introducing-open-source-pnp-spfx-yeoman-generator\/","title":{"rendered":"Introducing open-source PnP SPFx Yeoman generator"},"content":{"rendered":"

SharePoint Framework Yeoman templates are the way to scaffold your own solutions to start creating your own functionalities for SharePoint platform. As out-of-the-box Yeoman templates only support scaffolding for a limited set of JavaScript frameworks, the community has been asking options to introduce\u00a0additional capabilities\u00a0using an open-source model. We are happy to announce<\/strong> the availability of the PnP SPFx Yeoman generator<\/a>, which enables the community to work together with the\u00a0SharePoint engineering<\/strong> and to add new supported JavaScript framework and other options to the templates.<\/p>\n

PnP SPFx Yeoman generator extends<\/strong> the out-of-the-box SharePoint Framework Yeoman templates and does not replace them<\/strong>. It’s community driven initiative lead by the PnP Core team under surveillance\u00a0of the SharePoint engineering team. In long term, we are also looking into open-sourcing the out-of-the-box templates, but as that will not happen in short term, we can use the PnP SPFx Yeoman project to extend and enhance the development experience for SharePoint Framework developers.<\/p>\n

\"PnP<\/p>\n

With this first release, we have added support for HandbarJS and capabilities for adding optionally jQuery<\/a> or PnPjs<\/a> libraries to your solution automatically.\u00a0We are looking into also adding VueJS<\/a>\u00a0soon on the project together with the community. Your ideas, feedback, and contributions will drive the next steps of the development.<\/p>\n

How to get started?<\/h2>\n

You can get started by installing<\/strong> the generator by installing PnP SPFx Yeoman generator with the following command<\/p>\n

npm install -g @pnp\/generator-spfx<\/p><\/blockquote>\n

After installation, you\u00a0can start a new project<\/strong> execute the following command:<\/p>\n

yo @pnp\/spfx<\/p><\/blockquote>\n

We are excited to hear your feedback, ideas and use cases to help us as Microsoft and as a community to improve this community generator in the future. See the following resources for additional details about this project.<\/p>\n