create-easy-ui5

npm-init wrapper for the Easy-UI5 Yeoman generator.

create-easy-ui5 is a thin wrapper that makes the Easy-UI5 generator available through npm init, npx, and a standalone easy-ui5 binary — so you can scaffold a new UI5 project without installing Yeoman or the generator globally first. It automatically picks up all available UI5 Community generators.

Quick Start

You can use any of the three entry points below — they all do the same thing. Pick whichever fits your workflow.

# 1. via npm init (no install required)
npm init easy-ui5 [template]

# 2. via npx (no install required)
npx create-easy-ui5 [template]

# 3. via the installed binary
npm install -g create-easy-ui5
easy-ui5 [template]

If you omit [template], Easy-UI5 will prompt you to pick one interactively.

Requirements

• Node.js ≥ 20.17 (LTS). See DEPENDENCIES.md for the rationale behind this floor.

How it works

create-easy-ui5 does three things on every invocation:

1. Creates a fresh Yeoman environment in the current working directory.
2. Looks up the easy-ui5:app generator from generator-easy-ui5 (or any compatible generator already installed locally / globally).
3. Hands control over to that generator, forwarding any CLI arguments you passed in.

That's it — the actual project scaffolding, prompts, and template logic all live in generator-easy-ui5 and the UI5 Community generators. If you hit something that looks like a template bug, please report it there.

Documentation & Templates

• Easy-UI5 generator — the upstream Yeoman generator this wrapper drives.
• UI5 Community generators — a catalogue of available [template] values.
• SAPUI5/OpenUI5 documentation — UI5 framework reference.

Support

This project is community-maintained. The best places to get help are:

• 🐛 Bug reports & feature requests: the issue tracker.
• 💬 General UI5 questions: the #tooling channel of the OpenUI5 Community Slack or Stack Overflow.

Please read the issue reporting guidelines before opening an issue.

Contributing

Contributions of any kind — bug reports, fixes, doc improvements, ideas — are warmly welcomed.

• CONTRIBUTING.md — how to set up, what we expect from pull requests, commit message rules, and the changeset-based release flow.
• DEPENDENCIES.md — why some dependencies are pinned; consult this before bumping anything.
• SECURITY.md — how to report vulnerabilities and the supply-chain controls in place on this repository.
• CODE_OF_CONDUCT.md — the Contributor Covenant we follow.

Release Process

This repository uses Changesets for versioning and automated publishing to npm. See the Releasing the Package section in the contributor guide.

License

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