X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=ui%2Fweb%2FREADME.md;h=1a129e14132574deb40be07d82f4352c8659a7a8;hb=05f068eb1d8a5f54581b93bb88e3b7353343bd3d;hp=1293c310d1fd3e13d8449f1044214e8ff809dbbd;hpb=15124b9a1fc61722af33085024d4f0c8d3c6d81c;p=e-mobility-charging-stations-simulator.git

diff --git a/ui/web/README.md b/ui/web/README.md
index 1293c310..1a129e14 100644
--- a/ui/web/README.md
+++ b/ui/web/README.md
@@ -1,52 +1,75 @@
 # 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": {
     "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
+
+Copy the configuration template [src/assets/config-template.json](./src/assets/config-template.json) to `public/config.json`.
 
-For both solution you can then follow the link displayed in the terminal at the end of compilation
+### Run
 
-#### Compiles and run for production
+#### Compiles for production and preview locally
 
 ```shell
-npm start
+pnpm preview
 ```
 
+#### Try it out
+
+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.
+
+### 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
 ```