fix(ui): move v-show to the UI server container component
[e-mobility-charging-stations-simulator.git] / ui / web / README.md
index f2c21d13074db20a4238a3f88d15dc27bdb0311f..1541dd2b276922697b64088af6dc477a9d64bde8 100644 (file)
@@ -23,8 +23,8 @@ The simulator UI server must be enabled, use WebSocket transport type and have a
     "enabled": true,
     "type": "ws",
     "authentication": {
-      "enabled": false,
-      "type": "basic-auth",
+      "enabled": true,
+      "type": "protocol-basic-auth",
       "username": "admin",
       "password": "admin"
     }
@@ -35,36 +35,24 @@ See [here](./../../README.md#charging-stations-simulator-configuration) for more
 
 #### Web UI configuration
 
-Copy the configuration template [src/assets/config-template.json](src/assets/config-template.json) to `public/config.json`.
+Copy the configuration template [src/assets/config-template.json](./src/assets/config-template.json) to `public/config.json`.
 
 ### Run
 
-#### Compiles for production
-
-```shell
-pnpm build
-```
-
-#### Compiles and preview locally for production
+#### Compiles for production and preview locally
 
 ```shell
 pnpm preview
 ```
 
-#### Compiles and run for production
-
-```shell
-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
+You can now follow the link displayed in the terminal. The Web UI looks like the following:
 
 ![webui](./src/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.
+1. With the buttons on the top you can start/stop the simulator, add new charging stations and refresh the content.
+2. Each charging station is a row in the table with specific 'Actions' to execute. Try 'Stop Charging Station' and refresh with the large blue button and see the status 'Started' turns from 'Yes' into 'No'.
 
 ### Development