Skip to content

Corrected commands for NPM using Node v20.12+ #77

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

Merged
merged 2 commits into from
Apr 23, 2025
Merged

Corrected commands for NPM using Node v20.12+ #77

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1c81895
Updated documentation regarding issue on Node v20.12+ with command li…
MartinaeyNL Apr 23, 2025
c8c95db
Merge branch 'main' into npm-arguments-fix
wborn Apr 23, 2025
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
8 changes: 4 additions & 4 deletions docs/developer-guide/working-on-ui-and-apps.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@ To work on an app for example the `Manager UI` :
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**)

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

* 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`)
* 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`)
* 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`)
* 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`)


## Consuming UI components
Expand Down Expand Up @@ -90,7 +90,7 @@ backend webpack_backend
```

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

### Components
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.
Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/deploying/custom-deployment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ This is easiest if you have an [SSH-key in your GitHub account](https://docs.git
3. [Set up your IDE](../../developer-guide/setting-up-an-ide.md). Note that Application run configurations are already prepared when using this template. \
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.
4. Run the modelWatch gradle task to build the typescript model `./gradlew modelWatch`
5. Next we serve the Manager UI from the `/openremote/ui/app/manager` directory with `npm run serve -- --env config=..\..\..\..\deployment\manager\app`.
5. Next we serve the Manager UI from the `/openremote/ui/app/manager` directory with `npm run serve "--" --env config=..\..\..\..\deployment\manager\app`.

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

Expand Down