UI5 Build and Development Tooling
An open and modular toolchain to develop state-of-the-art applications based on the UI5 framework.
- API Reference
- CLI Documentation
- Project Configuration
🎬UI5con@SAP 2018 Talk
- Contribution Guidelines
- ui5-cli: UI5 Command Line Interface, utilizing all of the following modules
- ui5-server: Modules for running a UI5 development server
- ui5-project: Modules for building a UI5 projects dependency tree, including configuration
- ui5-builder: Modules for building UI5 projects
- ui5-fs: UI5 specific file system abstraction
- ui5-logger: Internal logging module
Installing the UI5 CLI
- Node.js (version 8.5 or higher
npm install --global @ui5/cli # Verify installation ui5 --help
⚡️ Quick Start: OpenUI5 Sample App
Enable an Existing Project
You can easily check whether or not a project (application or library) can already be used with the UI5 Build and Development Tooling by looking for a
ui5.yaml file in the project's root directory.
This file (with some exceptions) is required for all projects and their dependencies (e.g. reuse libraries) to use them in the UI5 Build and Development Tooling.
If your project is not set up for use with the UI5 Build and Development Tooling yet, follow these steps:
If your project does not have a
package.jsonfile yet, let npm generate it:
npm init --yes
Install npm dependencies required for your project:
npm install @openui5/sap.ui.core @openui5/themelib_sap_belize [...]
For a full list of all available OpenUI5 libraries, see www.npmjs.com/org/openui5
If you are using Git or similar version control, commit
ui5.yamlto your repository.
Questions? Check the FAQ!
Working With the UI5 Build and Development Tooling
When developing a UI5 project locally, you should use the UI5 Server (
ui5 serve) and not the UI5 Builder (
ui5 build). Building a project should only ever be required when deploying it.
However, you might have good reasons to also use the UI5 Builder during development. In such cases, feel free to let us know! Maybe your use case could be covered by a future enhancement of the UI5 Server.
For details about how to configure a UI5 project (e.g. using a
ui5.yaml), see ui5-project - Configuration.
Would you like to work on an application project and one or more of its dependencies at the same time? We got you covered!
Example: Your Directory Structure
my-app/ \_ node_modules/ \_ webapp/ \_ ui5.yaml \_ package.json my-reuse-library/ \_ node_modules/ \_ src/ \_ test/ \_ ui5.yaml \_ package.json
my-app should already define a dependency to
my-reuse-library. So, after running the
npm install command, a copy of the "my-reuse-library"-package should be retrieved from the package registry and added to my-app's
Now all you need to do is replacing this copy of the
my-reuse-library package with a link to the
my-reuse-library project located somewhere on your computer. In this example it is right next to
my-app, but that doesn't really matter.
First, in the directory of the
my-reuse-library project, create a global link:
Then, in the
my-app directory, use that link to replace the registry package:
npm link my-reuse-library
Note: "my-reuse-library" is the name defined in the
package.json and not necessarily the directory or
That's it. You can check whether the linking worked by executing
ui5 tree in the
my-app directory and looking for the path attributes in its output:
├─ id: my-app ├─ version: 1.0.0 ├─ path: /my-app └─ dependencies ├─ 0 │ ├─ id: my-reuse-library │ ├─ version: 1.0.0 │ ├─ path: /my-reuse-library │ └─ dependencies [...]
OpenUI5 Framework Development
HTTP/2 Development Webserver
The UI5 Build and Development Tooling contains a web server to serve the project via HTTP/2 protocol.
ui5 serve --h2
This requires an SSL certificate. You are guided through the automatic generation process.
Integration in Other Tools
One of the key features of the UI5 Build and Development Tooling is its modularization. Single parts of the tooling can easily be integrated in other
Node.js-based tools and frameworks like Grunt or Gulp.
How can I contribute?
Please check our Contribution Guidelines.
How can I obtain support?
Please follow our Contribution Guidelines on how to report an issue.
Why package.json? / Why npm?
Currently, the tooling can only resolve dependencies defined in a
package.json file. This might change in the future by adding Translators for additional dependency management systems.
The UI5 Build and Development Tooling resolves dependencies almost the same way Node.js does when executing a
What's the thing with Yarn?
In a couple of guides we refer to the Yarn node package manager. This is because it offers functionality that the otherwise preferred npm package manager is currently lacking. Namely, the workspace setting which is currently used in the OpenUI5 (mono-)repository. Note that npm might add this feature in the future.
If you do not plan to work with OpenUI5, you may as well use npm or any other node package manger (see FAQ: Why package.json? / Why npm?). Keep in mind that linking the same module with npm and Yarn may cause issues. Also, Yarn can't work with links created by npm and vice versa.
Where are the npm packages?
Please check our Contribution Guidelines.
This project is licensed under the Apache Software License, Version 2.0 except as noted otherwise in the LICENSE file.