fix(ci): fix named import shelljs usage

[e-mobility-charging-stations-simulator.git] / ui / web / README.md

diff --git a/ui/web/README.md b/ui/web/README.md
index 1293c310d1fd3e13d8449f1044214e8ff809dbbd..1f5fdd3341e76793fbf8a842dcf418cc2525e90c 100644 (file)
--- a/ui/web/README.md
+++ b/ui/web/README.md
@@ -1,12 +1,22 @@
 # Web UI
 
+The Web UI code and configuration is in the repository directory [ui/web](./../../ui/web/). Commands execution is relative to that directory.
+
 ## Project setup
 
+### Dependencies
+
 ```shell
-npm install
+corepack enable
+corepack prepare pnpm@latest --activate
+pnpm install
 ```
 
-The simulator UI server must be enabled, use WebSocket and disable authentication. The simulator main configuration file should have a `uiServer` section like this:
+### Configuration
+
+#### Simulator UI Server Configuration
+
+The simulator UI server must be enabled, use WebSocket transport type and have authentication disabled. The simulator main configuration file should have a `uiServer` section like this:
 
 ```json
   "uiServer": {
@@ -21,32 +31,57 @@ The simulator UI server must be enabled, use WebSocket and disable authenticatio
   },
 ```
 
-See [here](../../README.md#charging-stations-simulator-configuration) for more details.
+See [here](./../../README.md#charging-stations-simulator-configuration) for more details.
+
+#### Web UI configuration
+
+Copy the configuration template [src/assets/config-template.ts](src/assets/config-template.ts) to `src/assets/config.ts`.
 
 ### Run
 
-For both solution you can then follow the link displayed in the terminal at the end of compilation
+#### Compiles for production
+
+```shell
+pnpm build
+```
+
+#### Compiles and preview locally for production
+
+```shell
+pnpm preview
+```
 
 #### Compiles and run for production
 
 ```shell
-npm start
+pnpm start
 ```
 
+#### Try it out
+
+For both options above you can then follow the link displayed in the terminal at the end of compilation. The Web UI looks like the following
+
+![webui](./assets/webui.png)
+
+1. With the top 2 buttons you can now stop and afterwards start the simulator and inspect the server console for the number of charging stations, e.g. with the default configuration: `Charging stations simulator ... started with 10 charging station(s)`
+2. Each charging station is a row in the table below, try "Stop Charging Station" and refresh with the large blue button and see the status Started turns from Yes into No.
+
+### Development
+
 #### Compiles and run for development
 
 ```shell
-npm run serve
+pnpm dev
 ```
 
-### Compiles and minifies for production
+#### Formats files
 
 ```shell
-npm run build
+pnpm format
 ```
 
-### Lints files
+#### Lints and fixes files
 
 ```shell
-npm run lint
+pnpm lint:fix
 ```