docs: ui/web/README.md: fix link, take 2

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

diff --git a/ui/web/README.md b/ui/web/README.md
index b14f6e4e3dc9de8889436a07e6cd92c61fe717a6..0781197a73079e0d7706e7cf17ff0fd75c1ff6d3 100644 (file)
--- a/ui/web/README.md
+++ b/ui/web/README.md
@@ -1,35 +1,63 @@
 # 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
 
 ```shell
-npm install
+corepack enable
+corepack prepare pnpm@latest --activate
+pnpm install
 ```
 
-### Run
+The simulator UI server must be enabled, use WebSocket and disable authentication. The simulator main configuration file should have a `uiServer` section like this:
+
+```json
+  "uiServer": {
+    "enabled": true,
+    "type": "ws",
+    "authentication": {
+      "enabled": false,
+      "type": "basic-auth",
+      "username": "admin",
+      "password": "admin"
+    }
+  },
+```
 
-For both solution you can then follow the link displayed in the terminal at the end of compilation
+See [here](../../README.md#charging-stations-simulator-configuration) for more details.
+
+### Run
 
 #### Compiles and run for production
 
 ```shell
-npm start
+pnpm start
 ```
 
 #### Compiles and run for development
 
 ```shell
-npm run serve
+pnpm serve
 ```
 
+#### 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.
+
 ### Compiles and minifies for production
 
 ```shell
-npm run build
+pnpm build
 ```
 
 ### Lints files
 
 ```shell
-npm run lint
+pnpm lint
 ```