Skip to content

Commit ae455fe

Browse files
authored
Updated documentation regarding issue on Node v20.12+ with command line arguments for npm run scripts (#77)
1 parent bb815cb commit ae455fe

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

docs/developer-guide/working-on-ui-and-apps.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,10 @@ To work on an app for example the `Manager UI` :
2222
Compiles the typescript model from java code and then starts webpack dev server and serves the web app which can then be accessed at `http://localhost:9000/manager/` (**NOTE: trailing `/` is required**)
2323

2424
### Webpack dev server environment variables
25-
The following environment variables can be set when running `npm run serve` using the syntax `npm run serve -- --env ENV_NAME=ENV_VALUE`:
25+
The following environment variables can be set when running `npm run serve` using the syntax `npm run serve "--" --env ENV_NAME=ENV_VALUE`:
2626

27-
* managerUrl - By default webpack dev server expects the manager to be available at `http://localhost:8080` but this can be configured for example when running the manager Docker image (e.g. `npm run serve -- --env managerUrl=https://localhost`)
28-
* keycloakUrl - By default Keycloak expects to be available at `managerUrl/auth` but this can be configured for example when running the manager Docker image (e.g. `npm run serve -- --env keycloakUrl=https://keycloak/auth`)
27+
* managerUrl - By default webpack dev server expects the manager to be available at `http://localhost:8080` but this can be configured for example when running the manager Docker image (e.g. `npm run serve "--" --env managerUrl=https://localhost`)
28+
* keycloakUrl - By default Keycloak expects to be available at `managerUrl/auth` but this can be configured for example when running the manager Docker image (e.g. `npm run serve "--" --env keycloakUrl=https://keycloak/auth`)
2929

3030

3131
## Consuming UI components
@@ -90,7 +90,7 @@ backend webpack_backend
9090
```
9191

9292
* Ctrl/Cmd-D to exit the proxy container shell
93-
* Start the webpack dev server in the `ui/app/manager`: `npm run serve -- --env managerUrl=https://demo.openremote.app`
93+
* Start the webpack dev server in the `ui/app/manager`: `npm run serve "--" --env managerUrl=https://demo.openremote.app`
9494

9595
### Components
9696
Components can be developed and tested in isolation (with dependencies on other components and/or public npm modules as required). Some components have no visuals and provide standard OpenRemote functionality e.g. `@openremote/core`, whilst others provide visuals that allow interaction with the Manager backend.

docs/user-guide/deploying/custom-deployment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ This is easiest if you have an [SSH-key in your GitHub account](https://docs.git
1717
3. [Set up your IDE](../../developer-guide/setting-up-an-ide.md). Note that Application run configurations are already prepared when using this template. \
1818
Use `docker-compose -f profile\dev-testing.yml up --build -d` and run the 'Custom Deployment' configuration. You should have two containers running in Docker, and the manager through your IDE.
1919
4. Run the modelWatch gradle task to build the typescript model `./gradlew modelWatch`
20-
5. Next we serve the Manager UI from the `/openremote/ui/app/manager` directory with `npm run serve -- --env config=..\..\..\..\deployment\manager\app`.
20+
5. Next we serve the Manager UI from the `/openremote/ui/app/manager` directory with `npm run serve "--" --env config=..\..\..\..\deployment\manager\app`.
2121

2222
With that done you should be looking at the manager on http://localhost:9000/manager/ (log in with admin/secret)
2323

0 commit comments

Comments
 (0)