refactor(ui): always display the buttons bar

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

diff --git a/ui/web/README.md b/ui/web/README.md
index 6e554a492315124d18361c6744626821d8637e51..5546785219de47963e494ad9b9d26c98465e5539 100644 (file)
--- a/ui/web/README.md
+++ b/ui/web/README.md
@@ -1,61 +1,120 @@
 # 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
-corepack enable
-corepack prepare pnpm@latest --activate
-pnpm install
-```
+### Configuration
+
+#### Simulator UI Server Configuration
 
-The simulator UI server must be enabled, use WebSocket and disable authentication. The simulator main configuration file should have a `uiServer` section like this:
+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": {
     "enabled": true,
     "type": "ws",
     "authentication": {
-      "enabled": false,
-      "type": "basic-auth",
+      "enabled": true,
+      "type": "protocol-basic-auth",
       "username": "admin",
       "password": "admin"
     }
   },
 ```
 
-See [here](../../README.md#charging-stations-simulator-configuration) for more details.
+See [here](./../../README.md#charging-stations-simulator-configuration) for more details.
 
-### Run
+#### Web UI configuration
 
-#### Compiles and run for production
+Copy the configuration template [src/assets/config-template.json](./src/assets/config-template.json) to `public/config.json`.
 
-```shell
-pnpm start
+##### Unique UI server:
+
+```json
+{
+  "uiServer": {
+    "host": "localhost",
+    "port": 8080,
+    "protocol": "ui",
+    "version": "0.0.1",
+    "authentication": {
+      "enabled": true,
+      "type": "protocol-basic-auth",
+      "username": "admin",
+      "password": "admin"
+    }
+  }
+}
 ```
 
-#### Compiles and run for development
+##### Multiple UI servers:
+
+```json
+{
+  "uiServer": [
+    {
+      "host": "server1.domain.tld",
+      "port": 8080,
+      "protocol": "ui",
+      "version": "0.0.1",
+      "authentication": {
+        "enabled": true,
+        "type": "protocol-basic-auth",
+        "username": "admin",
+        "password": "admin"
+      }
+    },
+    ...
+    {
+      "host": "serverN.domain.tld",
+      "port": 8080,
+      "protocol": "ui",
+      "version": "0.0.1",
+      "authentication": {
+        "enabled": true,
+        "type": "protocol-basic-auth",
+        "username": "admin",
+        "password": "admin"
+      }
+    }
+  ]
+}
+```
+
+### Run
+
+#### Compiles for production and preview locally
 
 ```shell
-pnpm run serve
+pnpm preview
 ```
 
 #### 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](./assets/webui.png)
+![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 change UI server, 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 on. 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
+pnpm dev
+```
 
-### Compiles and minifies for production
+#### Formats files
 
 ```shell
-pnpm run build
+pnpm format
 ```
 
-### Lints files
+#### Lints and fixes files
 
 ```shell
-pnpm run lint
+pnpm lint:fix
 ```