generator-ui5-ts-app

Yeoman generator kickstarting the development of UI5 applications using TypeScript. The generator incorporates the latest best-practices, is using the UI5 CLI and the UI5 CLI extensions provided by the UI5 community. It is maintained by the UI5 community and OpenUI5/SAPUI5 developers. This generator was build as a plug-in for the community project Easy-UI5 by SAP.

Usage with Easy-UI5

$> npm i -g yo generator-easy-ui5
$> yo easy-ui5 ts-app

     _-----_
    |       |    ╭──────────────────────────╮
    |--(o)--|    │  Welcome to the easy-ui5 │
   `---------´   │        generator!        │
    ( _´U`_ )    ╰──────────────────────────╯
    /___A___\   /
     |  ~  |
   __'.___.'__
 ´   `  |° ´ Y `

After the generation of your project you can use npm start (or yarn start) to start the local development server.

Standalone usage

Note the different greeting when the generator starts:

$> npm i -g yo
$> yo ./generator-ui5-ts-app

     _-----_     ╭──────────────────────────╮
    |       |    │      Welcome to the      │
    |--(o)--|    │   generator-ui5-ts-app   │
   `---------´   │        generator!        │
    ( _´U`_ )    ╰──────────────────────────╯
    /___A___\   /
     |  ~  |
   __'.___.'__
 ´   `  |° ´ Y `

Support

Please use the GitHub bug tracking system to post questions, bug reports or to create pull requests.

Contributing

We welcome any type of contribution (code contributions, pull requests, issues) to this generator equally.

Development Setup

git clone https://github.com/ui5-community/generator-ui5-ts-app.git
cd generator-ui5-ts-app
npm run setup

npm run setup installs dependencies and sets up the git hooks (Husky pre-commit for formatting and linting). The project uses ignore-scripts=true in .npmrc for supply-chain security, which prevents the automatic prepare lifecycle script from running — npm run setup handles both steps in one command.

License

This project is licensed under the Apache Software License, version 2.0 except as noted otherwise in the LICENSE file.