Merge branch 'main' into combined-prs-branch

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

diff --git a/ui/web/README.md b/ui/web/README.md
index 8dc9378925efa436bee08bae16efa12eb1aaf4e3..43bb9569139480ec1b1d3fd25f130666e4ec01c5 100644 (file)
--- a/ui/web/README.md
+++ b/ui/web/README.md
@@ -1,16 +1,28 @@
+<div align="center">
+
 # Web UI
 
-The Web UI code and configuration is in the repository directory [ui/web](./../../ui/web/). Commands execution is relative to that directory.
+</div>
 
-## Project setup
+The Web UI code and configuration is in the repository directory [ui/web](./../../ui/web/). Commands execution is relative to that directory.
 
-### Dependencies
+## 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)
 
-```shell
-corepack enable
-corepack prepare pnpm@latest --activate
-pnpm install
-```
+## Project setup
 
 ### Configuration
 
@@ -37,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
 {
@@ -56,7 +68,7 @@ Copy the configuration template [src/assets/config-template.json](./src/assets/c
 }
 ```
 
-##### Multiple UI servers:
+##### Multiple UI servers
 
 ```json
 {
@@ -92,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: