You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-15Lines changed: 8 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,7 +18,7 @@ Please edit this file as it is the primary description file for your project. Yo
18
18
19
19
# OpenUI5 TypeScript Walkthrough
20
20
21
-
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.
21
+
In this tutorial we'll introduce you to all major development paradigms of OpenUI5. <detailsclass="ts-only"markdown="1"><summary>This section is relevant for TypeScript only</summary>We'll also demonstrate the use of TypeScript with OpenUI5 and highlight the specific characteristics of this approach.</details>
22
22
23
23
## Description
24
24
@@ -80,13 +80,15 @@ The tutorial consists of the following steps. To start, just open the first link
80
80
81
81
## Requirements
82
82
83
-
The project uses npm workspaces and requires a [Node.js](https://nodejs.org/) version >= `20.11.0` to be installed.
83
+
Running the content of this repository locally (as opposed to following the tutorial steps) requires a [Node.js](https://nodejs.org/) version >= `20.11.0` to be installed.
84
84
85
-
### Getting Started
85
+
## Download and Installation
86
+
87
+
> This section describes how to run the content of the repository locally and is *not* required for following the tutorial. For following the tutorial, simply start with Step 1 in the list of steps above. From there, you can also download and run the result of each step locally.
86
88
87
-
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.
89
+
The project is set up 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.
88
90
89
-
To setup the monorepo you first need to install all depenedencies:
91
+
To set up the monorepo you first need to install all depenedencies:
90
92
91
93
```sh
92
94
npm install
@@ -103,15 +105,6 @@ cd steps/01
103
105
npm start
104
106
```
105
107
106
-
## Download and Installation
107
-
108
-
<!--
109
-
TODO
110
-
111
-
* create GitHub pages to showcase the built examples
112
-
* create ZIP files for each step which can be downloaded
113
-
-->
114
-
115
108
## Known Issues
116
109
117
110
No known issues.
@@ -128,4 +121,4 @@ If you wish to contribute code, offer fixes or improvements, please send a pull
128
121
129
122
## License
130
123
131
-
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](LICENSE) file.
124
+
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.
Copy file name to clipboardExpand all lines: README_AUTHORS.md
+4-2Lines changed: 4 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,13 +24,15 @@ To immediately preview the markdown document you are writing *including* the two
24
24
npm i
25
25
```
26
26
27
-
in the root folder of this project once for the setup, then to actually run the server, run
27
+
in the root folder of this project once for the setup.
28
+
29
+
Then, to actually start the server, run
28
30
29
31
```sh
30
32
npm start
31
33
```
32
34
33
-
Then, open http://localhost:1337/README.md in your browser and the browser will automatically open (on port 3000 or the next free port) and automatically reload on every saved change.
35
+
A browser window will automatically open (on port 3000 or the next free port) and automatically reload on every saved change.
34
36
35
37
36
38
## Writing *one* document which covers both JavaScript and TypeScript without duplication
0 commit comments