Merge pull request #990 from SAP/dependabot/npm_and_yarn/types/node-20.11.20

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

diff --git a/ui/web/README.md b/ui/web/README.md
index 0312229593e201cd3d37fcd576d169d6f48da164..1a129e14132574deb40be07d82f4352c8659a7a8 100644 (file)
--- a/ui/web/README.md
+++ b/ui/web/README.md
@@ -1,63 +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.
+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
 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
 
-#### 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
-```
+### Run
 
-#### Compiles and run for development
+#### Compiles for production and preview locally
 
 ```shell
-pnpm 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.
 
-### Compiles and minifies for production
+### Development
+
+#### Compiles and run for development
+
+```shell
+pnpm dev
+```
+
+#### Formats files
 
 ```shell
-pnpm build
+pnpm format
 ```
 
-### Lints files
+#### Lints and fixes files
 
 ```shell
-pnpm lint
+pnpm lint:fix
 ```