search

SAP-samples / ui5-typescript-walkthrough

A walkthrough tutorial that introduces all major development paradigms of OpenUI5 using TypeScript with OpenUI5.
https://sap-samples.github.io/ui5-typescript-walkthrough/
Apache License 2.0
26 stars 19 forks source link
openui5 sample sample-code sapui5 tutorial typescript ui5 walkthrough

readme

REUSE status

OpenUI5 TypeScript Walkthrough

In this tutorial we'll introduce you to all major development paradigms of OpenUI5. We'll demonstrate the use of TypeScript with OpenUI5 and highlight the specific characteristics of this approach.

Description

We first introduce you to the basic development paradigms like Model-View-Controller and establish a best-practice structure of our application. We'll do this along the classic example of “Hello World” and start a new app from scratch. Next, we'll introduce the fundamental data binding concepts of OpenUI5 and extend our app to show a list of invoices. We'll continue to add more functionality by adding navigation, extending controls, and making our app responsive. We'll also have look at the testing features and the built-in support tools of OpenUI5.

Preview

Preview of the OpenUI5 application that is going to be built in this tutorial. Contains a Hello World upper part with buttons and a text input. The lower part shows list of invoices with details, grouped by vendor names.

💡 Tip:
You don't have to do all tutorial steps sequentially, you can also jump directly to any step you want. Just download the code from the previous step and make sure that the application runs as intended.

You can view the samples for all steps here in this repository.

For more information, read the Getting Started section below.

Steps

The tutorial consists of the following steps. To start, just open the first link - you`ll be guided from there.

Requirements

The project uses npm workspaces and requires a Node.js version >= 20.11.0 to be installed.

Getting Started

The project is setup as monorepo. All steps are located inside the steps folder and labelled with their step number. The monorepo uses npm workspaces to manage all steps together. But you can also run npm inside each individual step.

To setup the monorepo you first need to install all depenedencies:

npm install

To run any step, just execute one of the scripts from package.json via npm, e.g.:

# Option 1: use workspace command to start the step
npm start -w ui5.walkthrough.step01

# Option 2: change to the folder of the step and start it
cd steps/01 
npm start

Download and Installation

Known Issues

No known issues.

How to obtain support

Create an issue in this repository if you find a bug or have questions about the content.

For additional support, ask a question in OpenUI5 Community on Slack.

Contributing

If you wish to contribute code, offer fixes or improvements, please send a pull request. Due to legal reasons, contributors will be asked to accept a DCO when they create the first pull request to this project. This happens in an automated fashion during the submission process. SAP uses the standard DCO text of the Linux Foundation.

License

Copyright (c) 2024 SAP SE or an SAP affiliate company. All rights reserved. This project is licensed under the Apache Software License, version 2.0 except as noted otherwise in the LICENSE file.