Skip to content

Commit 831f035

Browse files
authored
Update working-on-ui-and-apps.md (#43)
1 parent d992e25 commit 831f035

File tree

2 files changed

+24
-6
lines changed

2 files changed

+24
-6
lines changed

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

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,18 @@ sidebar_position: 5
88
Front end applications are [webcomponent](https://www.webcomponents.org/) based using the [lit](https://lit.dev/) library and [Material Design](https://material.io/components?platform=web) for styling. We use a combination of Polymer LIT, Material Design and our own OpenRemote elements. The UI components are [published on NPM](https://www.npmjs.com/org/openremote). The applications themselves are composed of our re-usable modular UI components which can be found in the code base in the [ui/component](https://github.com/openremote/openremote/tree/master/ui/component) folder, these are also published to [NPM](https://www.npmjs.com/org/openremote).
99

1010
## Working on an app (e.g. Manager UI)
11-
To work on an app for example the `Manager UI` then `cd` into the app directory e.g. `ui/app/manager` and run the following `npm` script:
12-
13-
- `npm run serve` - 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**)
11+
To work on an app for example the `Manager UI` :
12+
- From the main directory, start the required containers, use dev-ui.yml for example:
13+
```shell
14+
docker-compose -f profile/dev-ui.yml up -d
15+
```
16+
By default, this makes the manager container serve the apps present in the latest docker image on port 8080 e.g. `http://localhost:8080/manager/` . While these apps are not necessary for this case, the included manager container webservice is.
17+
18+
- `cd` into the app directory e.g. `ui/app/manager` and run the following `npm` script:
19+
```shell
20+
npm run serve
21+
```
22+
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**)
1423

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

versioned_docs/version-1.2.0/developer-guide/working-on-ui-and-apps.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,18 @@ sidebar_position: 5
88
Front end applications are [webcomponent](https://www.webcomponents.org/) based using the [lit](https://lit.dev/) library and [Material Design](https://material.io/components?platform=web) for styling. We use a combination of Polymer LIT, Material Design and our own OpenRemote elements. The UI components are [published on NPM](https://www.npmjs.com/org/openremote). The applications themselves are composed of our re-usable modular UI components which can be found in the code base in the [ui/component](https://github.com/openremote/openremote/tree/master/ui/component) folder, these are also published to [NPM](https://www.npmjs.com/org/openremote).
99

1010
## Working on an app (e.g. Manager UI)
11-
To work on an app for example the `Manager UI` then `cd` into the app directory e.g. `ui/app/manager` and run the following `npm` script:
12-
13-
- `npm run serve` - 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**)
11+
To work on an app for example the `Manager UI` :
12+
- From the main directory, start the required containers, use dev-ui.yml for example:
13+
```shell
14+
docker-compose -f profile/dev-ui.yml up -d
15+
```
16+
By default, this makes the manager container serve the apps present in the latest docker image on port 8080 e.g. `http://localhost:8080/manager/` . While these apps are not necessary for this case, the included manager container webservice is.
17+
18+
- `cd` into the app directory e.g. `ui/app/manager` and run the following `npm` script:
19+
```shell
20+
npm run serve
21+
```
22+
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**)
1423

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

0 commit comments

Comments
 (0)