Skip to content

feat: add Navigation and OData V4 tutorials, align all packages #295

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
petermuessig wants to merge 3 commits into
base: main
Choose a base branch
from
+58,775 −10,611
Open

feat: add Navigation and OData V4 tutorials, align all packages #295

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
93e73e6
feat: add Navigation and OData V4 tutorials, align all packages
petermuessig Jun 29, 2026
9b4f266
chore: align tutorials to UI5 1.148 LTS and normalize conventions
petermuessig Jun 30, 2026
cf4d69d
chore: migrate from @types/openui5 to @openui5/types
petermuessig Jul 1, 2026
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
_
.vscode
dist
node_modules
Expand Down
27 changes: 26 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,31 @@ We first introduce you to the basic development paradigms like *Model-View-Contr
This repository contains following tutorials:
- [Quickstart](./packages/quickstart/)
- [Walkthrough](./packages/walkthrough/)
- [Navigation and Routing](./packages/navigation/)
- [OData V4](./packages/odatav4/)

## Running locally

The repository is set up as an npm workspaces monorepo. Each tutorial step under `packages/*/steps/*` is a self-contained app you can run standalone, and the root build orchestrator produces a unified preview that mirrors the published GitHub Pages site.

```sh
# 1) install dependencies for every step
npm install

# 2) build every tutorial step (produces dist/<tutorial>/build/NN/ apps + ZIP downloads)
npm run build

# 3) serve the rendered tutorial pages with working Live Preview links
npm start
```

After `npm start`, open <http://localhost:1337/packages/walkthrough/> (or any other tutorial's `packages/<name>/`). The dev server renders the markdown overview, rewrites the published `https://ui5.github.io/tutorials/...` URLs to point at the local `dist/`, and serves the built apps from the same origin.

To run a single step directly without going through the build:

```sh
npm start -w ui5.tutorial.walkthrough.step15
```

## How to obtain support

Expand All @@ -26,4 +51,4 @@ If you wish to contribute code, offer fixes or improvements, please send a pull

## License

Copyright (c) 2025 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](LICENSE) file.
Copyright (c) 2026 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](LICENSE) file.
Loading
Loading