@sapui5/generator-sapui5-templates

generator-sapui5-templates

Description

The Yeoman SAPUI5 templates project is a generic Yeoman wrapper for SAPUI5 templates from the SAPUI5 distribution. It uses our tried-and-true original templates:

• SAP Fiori Worklist Application (1worklist)
• SAP Fiori Master-Detail Application (2masterdetail)
• SAP Fiori Worklist Application OData V4 (3worklistodatav4)

You can finally use a Yeoman generator to create an application based on one of the SAPUI5 templates mentioned above. Just follow the Yeoman prompts to fill in the missing properties. The major.minor version of the templates is aligned with the version of the SAPUI5 distribution.

Installation

You can install the Yeoman generator either globally or locally. The following chapters explain both options.

Global

1. Get Node.js (version 8.5 or higher).
2. Install the generator globally:

   npm install -g yo @sapui5/generator-sapui5-templates
   

3. Verify your installation to see if Yeoman has been installed correctly:

   yo --generators
   

   If the @sapui5/sapui5-templates generator is listed, you're ready to go.

Local

1. Go into the root folder of your existing Node project.
2. Install the generator locally:

   npm install @sapui5/generator-sapui5-templates --save-dev
   

3. Verify your installation to see if Yeoman has been installed correctly:

   yo --generators
   

   If the @sapui5/sapui5-templates generator listed, you're ready to go.

Usage

Create Your First SAPUI5 App in Seconds!

This will set up a basic SAPUI5 app with a file structure that follows our best practices.

1. Scaffold your SAPUI5 project:

   yo @sapui5/sapui5-templates
   

2. Answer the prompts to create your SAPUI5 project.
3. Run your app locally:

   cd <your project name>
   npm start
   

Create Your SAP Fiori Worklist Application in Seconds!

This will set up a typical worklist floorplan.

1. Scaffold your SAP Fiori worklist application project:

   yo @sapui5/sapui5-templates:1worklist
   

2. Answer the prompts to create your SAP Fiori worklist application project.
3. Run your worklist app locally

   cd <your project name>
   npm start
   

You can use this procedure for any of the available templates, just use the proper template ID:

• SAP Fiori Worklist Application (template ID: 1worklist)
• SAP Fiori Master-Detail Application (template ID: 2masterdetail)
• SAP Fiori Worklist Application OData V4 (template ID: 3worklistodatav4)

License

The Yeoman generator for the SAPUI5 templates is provided under the terms of the SAP DEVELOPER LICENSE AGREEMENT.