ui5g icon indicating copy to clipboard operation
ui5g copied to clipboard

Yet another generator for UI5

Yet another generator for UI5

CircleCI npm version Known Vulnerabilities

The ultimate generator for OpenUI5/SAPUI5, provide the next generation syntax for UI5 environment.

Features

Example Project

UI5 To Do is a sample project built on the next generation UI5 technic. It contains:

  • es6 modules
  • jsx syntax
  • using npm module
  • redux integration. (so that user can inspect model by redux devtools)
  • reactive programming
  • no controller & view

features.

Installation & setup a new project

Firstly, install Yeoman and generator-ui5g using npm.

npm i -g yo generator-ui5g

Then run the yo ui5g command to generate your own project.

yo ui5g

The project will be generated in a new folder, and the folder name is same as app name.

Then, just execute the start command, wait a moment, the application will be opened in a new browser window (after build).

npm start

Build

Run the build command, and the production artifacts will be generated in the dist directory (default).

npm run build

Configuration

  • babel, edit .babelrc to modify babel behavior, for example, make sourcemaps inline

  • eslint, edit .eslintrc to modify eslint lint config, by default, new project will use most rules of ui5 standard, only add es6 and other essential rules.

  • gulp, edit gulpfile.js to modify gulp task and other task behavior, you can add sass or uglify or other processes manually, or adjust src/dist directory

  • proxy, edit proxies.js, supported by gulp connect, use a traditional node lib, it can set local proxy to remote server

Command

  • npm start, default gulp will start a hot reload server, based on BrowserSync. Recommended to develop in this way.

  • npm run build, build files to dist directory, and Component-preload.js will be created.

CHANGELOG

About

This generator is written by Theo but some ideas come from Madeleine.

The idea of JSX Support is from Kenny, just a syntactic sugar.

Very pleased to be able to help you.