X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=ui%2Fweb%2FREADME.md;h=6f76f1eca10fdad49518cf9acda247ad28858e52;hb=293aaa3118bbd8c6a6e7933f049d51031c134fa6;hp=b14f6e4e3dc9de8889436a07e6cd92c61fe717a6;hpb=ebbfbf1c01e010d051956867484b74a94237f546;p=e-mobility-charging-stations-simulator.git diff --git a/ui/web/README.md b/ui/web/README.md index b14f6e4e..6f76f1ec 100644 --- a/ui/web/README.md +++ b/ui/web/README.md @@ -6,9 +6,24 @@ npm install ``` -### Run +The simulator UI server must be enabled, use WebSocket and disable authentication. The simulator main configuration file should have a `uiServer` section like this: + +```json + "uiServer": { + "enabled": true, + "type": "ws", + "authentication": { + "enabled": false, + "type": "basic-auth", + "username": "admin", + "password": "admin" + } + }, +``` -For both solution you can then follow the link displayed in the terminal at the end of compilation +See [here](../../README.md#charging-stations-simulator-configuration) for more details. + +### Run #### Compiles and run for production @@ -22,6 +37,15 @@ npm start npm run serve ``` +#### 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 + +![webui](./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 ```shell