X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=ui%2Fweb%2FREADME.md;h=43bb9569139480ec1b1d3fd25f130666e4ec01c5;hb=fa30db101a2d11774bd9b29ca806597865ea06bf;hp=5546785219de47963e494ad9b9d26c98465e5539;hpb=749d72306546377b9a9a625b25658bcc55b61597;p=e-mobility-charging-stations-simulator.git
diff --git a/ui/web/README.md b/ui/web/README.md
index 55467852..43bb9569 100644
--- a/ui/web/README.md
+++ b/ui/web/README.md
@@ -1,7 +1,27 @@
+
+
# Web UI
+
+
The Web UI code and configuration is in the repository directory [ui/web](./../../ui/web/). Commands execution is relative to that directory.
+## Table of contents
+
+- [Project setup](#project-setup)
+ - [Configuration](#configuration)
+ - [Simulator UI Server Configuration](#simulator-ui-server-configuration)
+ - [Web UI configuration](#web-ui-configuration)
+ - [Unique UI server](#unique-ui-server)
+ - [Multiple UI servers](#multiple-ui-servers)
+ - [Run](#run)
+ - [Compiles and run for production](#compiles-and-run-for-production)
+ - [Preview locally](#preview-locally)
+ - [Development](#development)
+ - [Compiles and run for development](#compiles-and-run-for-development)
+ - [Formats files](#formats-files)
+ - [Lints and fixes files](#lints-and-fixes-files)
+
## Project setup
### Configuration
@@ -29,7 +49,7 @@ See [here](./../../README.md#charging-stations-simulator-configuration) for more
Copy the configuration template [src/assets/config-template.json](./src/assets/config-template.json) to `public/config.json`.
-##### Unique UI server:
+##### Unique UI server
```json
{
@@ -48,7 +68,7 @@ Copy the configuration template [src/assets/config-template.json](./src/assets/c
}
```
-##### Multiple UI servers:
+##### Multiple UI servers
```json
{
@@ -84,13 +104,13 @@ Copy the configuration template [src/assets/config-template.json](./src/assets/c
### Run
-#### Compiles for production and preview locally
+#### Compiles and run for production
```shell
pnpm preview
```
-#### Try it out
+#### Preview locally
You can now follow the link displayed in the terminal. The Web UI looks like the following: