Skip to content

Commit

Permalink
docs: update installation.md (#185)
Browse files Browse the repository at this point in the history
* update installation.md

add section "reinitialize setup"

* docs: add npm update hint

* docs: add command to start wdi5 manually
  • Loading branch information
tompaulusch authored Mar 24, 2022
1 parent 3458b34 commit 5bc2ccb
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 3 deletions.
6 changes: 4 additions & 2 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,12 @@
## 🏃 for the impatient developer

```shell
# you need npm 7+ → we're using npm's workspaces feature
$> npm --version
# use reference node version
$> nvm use
# you need npm 7+ → we're using npm's workspaces feature
$> npm --version
# eventually update npm itself with command:
$> npm install -g npm@latest
# will also install all deps in workspaces + setup pre-commit hooks
$> npm i
# build entire proj once
Expand Down
8 changes: 7 additions & 1 deletion docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ With `wdi5` [being a service to WebdriverIO](https://webdriver.io/docs/wdio-ui5-

## Prerequisites

- UI5 app running in the browser, accessbile via `http(s)://host.ext:port`.
- UI5 app running in the browser, accessible via `http(s)://host.ext:port`.
Recommended tooling for this is either the official [UI5 tooling](https:/SAP/ui5-tooling) (`ui5 serve`) or some standalone http server like [`soerver`](https:/vobu/soerver) or [`http-server`](https://www.npmjs.com/package/http-server).
- Node.js version >= `14` (`lts/fermium`)

Expand Down Expand Up @@ -58,6 +58,12 @@ At the end of the guided installation, you'll be greated with a message similar

:arrow_right: Continue with the [configuration](configuration) now.

## reinitialize setup
If you have issues with your `wdio.conf.(j|t)s` file or want to reinitialize the guided installation:
```shell
$> npx wdio config
```

## manual installation

In case you already have a `wdio.conf.(j|t)s` file, getting `wdi5` is a straightforward process.
Expand Down
6 changes: 6 additions & 0 deletions docs/running.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,10 @@ Then, kick off the test(s) via `wdio` (that, for best practice, should be wrappe

![wdio for executing wdi5 tests](./img/23_running.png)

To start the test without creating an npm script:

```shell
$> node_modules/.bin/wdio run wdio-ui5tooling.conf.js "--spec" "basic"
```

Voilà!

0 comments on commit 5bc2ccb

Please sign in to comment.