Skip to content
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

Add Setup instructions #125

Merged
merged 4 commits into from
Jul 10, 2024
Merged

Add Setup instructions #125

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5438261
Add npx commands to allow execution of ui5 commands
konnraad May 27, 2024
19df414
Add installation instructions to include global installation.
konnraad May 27, 2024
3ff8f34
Added Setup instructions
konnraad May 28, 2024
5169ff8
Merge branch 'main' into patch-1
KlattG Jul 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/03_Get-Started/step-1-ready-851bde4.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,11 +116,11 @@ You can view and download all files at [Quick Start - Step 1](https://ui5.sap.co

7. Open a terminal in the app root folder and execute `npm i -D @ui5/cli` to install UI5 Tooling.

8. Execute `ui5 init` in the app root folder.
8. Execute `npx ui5 init` in the app root folder.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would need to be npx @ui5/cli init (https://www.npmjs.com/package/@ui5/cli), right? There's no package named ui5, as it is a scope.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

true

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@konnraad feel free to adjust the PR

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well, I think I missed some detail. npx ui5 works fine, if you have the @ui5/cli package installed in your project. Which is the case in this scenario. But IMO this leads to a lot of confusion (as it already confused me).

npm exec ui5 would be the correct and safe way of invoking the local ui5 binary in a package. This way you don't accidentally try to install the ui5 package. But again, this is then also longer to type.

And our global ui5 CLI invokes the local installation, so there's no downside of having a global and local installation.

Copy link
Contributor Author

@konnraad konnraad May 27, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think a better solution would be to install it as a dev dependency and also globally.
I've tested on my device, and it worked for me.
(I've updated my initial PR)

It would look like this:

npm install -D -g @ui5/cli

schauen wir mal was wird


9. Execute `ui5 use OpenUI5`
9. Execute `npx ui5 use OpenUI5`

10. Execute `ui5 add sap.m sap.tnt sap.ui.core sap.ui.layout themelib_sap_horizon`
10. Execute `npx ui5 add sap.m sap.tnt sap.ui.core sap.ui.layout themelib_sap_horizon`

11. Execute `npm start` to start the web server and to open a new browser window hosting your newly created `index.html`.

Expand Down
Loading