An open and modular toolchain to develop state of the art applications based on the UI5 framework
Clone or download

README.md

UI5 logo

UI5 Build and Development Tooling

An open and modular toolchain to develop state of the art applications based on the UI5 framework.

OpenUI5 Community Slack (#tooling channel) Travis CI Build Status

This is an alpha release!
The UI5 Build and Development Tooling described here is not intended for productive use yet. Breaking changes are to be expected.

Resources

Modules

  • ui5-cli: UI5 Command Line Interface, utilizing all of the following modules
  • ui5-builder: Modules for building UI5 projects
  • ui5-server: Modules for running a UI5 development server
  • ui5-fs: UI5 specific file system abstraction
  • ui5-project: Modules for building a UI5 projects dependency tree, including configuration
  • ui5-logger: Internal logging module

Installing the UI5 CLI

Requirements

  • Node.js (version 8.5 or higher ⚠️)

Installation

npm install --global @ui5/cli

# Verify installation
ui5 --help

⚑️ Quick start: OpenUI5 Sample App

Checkout the OpenUI5 Sample App featuring a full blown How-to to play around with the UI5 Build and Development Tooling.

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 projects 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.

Setup

If your project is not setup for use with the UI5 Build and Development Tooling yet, follow these steps:

  1. If your project does not have a package.json file yet, let npm generate it

    npm init --yes
  2. Generate the ui5.yaml file

    ui5 init
  3. 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

  4. If you are using Git or similar version control, commit package.json and ui5.yaml to your repository

Questions? Check the FAQ!

Project Configuration

For details about how to configure a UI5 project (e.g. using a ui5.yaml) see ui5-project - Configuration.

Linking Projects

You would like to work on an application project and one or more of its dependencies at the same time? We got you covered!

By leaving dependency management up to the tool of your choice (see FAQ: Why package.json? / Why npm?) you have a variety of options.
Let's have an example with npm, an application and a reuse library:

Example: Your directory structure

my-app/
    \_ node_modules/
    \_ webapp/
    \_ ui5.yaml
    \_ package.json
my-reuse-library/
    \_ node_modules/
    \_ src/
    \_ test/
    \_ ui5.yaml
    \_ package.json

In its 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 node_modules/ directory.

Now all you need to do is replacing this copy of 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:

npm 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. Not necessarily the directory or ui5.yaml name

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

For OpenUI5 Framework Development, Yarn (version must be 1.0 or higher) is required.
See FAQ: What's the thing with Yarn?

  1. Clone the OpenUI5 repository and navigate into it
    git clone git@github.com:SAP/openui5.git
    cd openui5/
  2. Install all dependencies and create links between the OpenUI5 libraries
    yarn
  3. Start the OpenUI5 testsuite
    cd src/testsuite/
    ui5 serve -o /index.html

HTTP/2 Development Webserver

The UI5 Build and Development Tooling contain a webserver to serve the project via HTTP/2 protocol.

ui5 serve --h2

This will require an SSL certificate. You will be guided through the automatic generation process.

Advanced: Integration into other Build and Development Tooling

One of the key features of the UI5 Build and Development Tooling is its modularization. This allows for easy integration into other Node.js based tools and frameworks with a fairly low footprint.

The UI5 Build and Development CLI focuses on providing the best possible workflow for straight forward, best practice UI5 application and library development.
But if your project requires some additional build steps. If you already came up with your own set of tools to build and develop. Or if you want to define custom workflows, maybe with the help of task runners like Grunt or Gulp. Then you can make use of various modules that build up to the UI5 Build and Development Tooling.

FAQ

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.

To manage your dependencies you can use almost any Node.js package manager that relies on package.json files. Popular ones are npm, yarn and pnpm.

The UI5 Build and Development Tooling resolve dependencies almost the same way Node.js does when executing a require statement.

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 prefered npm package manager is currently lacking of. 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 might as well use npm or any other node package manger (see FAQ: Why package.json? / Why npm?. But keep in mind that linking the same module with npm and Yarn might lead to issues. Also, Yarn can't work with links created by npm and vice versa.

Where are the npm packages?

Here (OpenUI5 Libraries) and here (UI5 Tooling).

Contributing

Please check our Contribution Guidelines.

Support

Please follow our Contribution Guidelines on how to report an issue. Or chat with us in the #tooling channel of the OpenUI5 Community Slack

License

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