refactor(ui): refine configuration file type and make it conditional

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

diff --git a/ui/web/README.md b/ui/web/README.md
index 1035fe9ae821929077269f2605c24fd4634a61eb..ffbc5f0b76bce3b0b5c857e7fa051dc31287f064 100644 (file)
--- a/ui/web/README.md
+++ b/ui/web/README.md
@@ -4,13 +4,19 @@ The Web UI code and configuration is in the repository directory [ui/web](./../.
 
 ## 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": {
@@ -27,18 +33,28 @@ The simulator UI server must be enabled, use WebSocket and disable authenticatio
 
 See [here](./../../README.md#charging-stations-simulator-configuration) for more details.
 
+#### Web UI configuration
+
+Copy the configuration template [assets/config-template.ts](assets/config-template.ts) to `assets/config.ts`.
+
 ### Run
 
-#### Compiles and run for production
+#### Compiles for production
 
 ```shell
-pnpm start
+pnpm build
 ```
 
-#### Compiles and run for development
+#### Compiles and preview locally for production
+
+```shell
+pnpm preview
+```
+
+#### Compiles and run for production
 
 ```shell
-pnpm serve
+pnpm start
 ```
 
 #### Try it out
@@ -50,14 +66,22 @@ For both options above you can then follow the link displayed in the terminal at
 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 build
+pnpm dev
+```
+
+#### Formats files
+
+```shell
+pnpm format
 ```
 
-### Lints files
+#### Lints and fixes files
 
 ```shell
-pnpm lint
+pnpm lint:fix
 ```