From d6b76da3c2472471734aba87e78537f3bdb1f385 Mon Sep 17 00:00:00 2001 From: Olivier Bagot Date: Wed, 5 Oct 2022 09:01:12 +0200 Subject: [PATCH] Lint READMEs Fix typo in uiServer config example. --- README.md | 7 ++++--- src/ui/web/README.md | 10 +++++----- 2 files changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 50b717be..67d53434 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,4 @@ + # [e-mobility charging stations simulator](https://github.com/sap/e-mobility-charging-stations-simulator) [![REUSE status](https://api.reuse.software/badge/github.com/SAP/e-mobility-charging-stations-simulator)](https://api.reuse.software/info/github.com/SAP/e-mobility-charging-stations-simulator) @@ -26,7 +27,7 @@ choco install -y nodejs-lts brew install node@16 ``` -### GNU/Linux: +### GNU/Linux - [NodeSource](https://github.com/nodesource/distributions) Node.js Binary Distributions for version >= 16.X @@ -101,11 +102,11 @@ But the modifications to test have to be done to the files in the build target d | logFile | | combined.log | string | log file relative path | | logErrorFile | | error.log | string | error log file relative path | | worker | | {
"processType": "workerSet",
"startDelay": 500,
"elementStartDelay": 0,
"elementsPerWorker": 1,
"poolMinSize": 4,
"poolMaxSize": 16,
"poolStrategy": "ROUND_ROBIN"
} | {
processType: WorkerProcessType;
startDelay: number;
elementStartDelay: number;
elementsPerWorker: number;
poolMinSize: number;
poolMaxSize: number;
poolStrategy: WorkerChoiceStrategy;
} | Worker configuration section:
- processType: worker threads process type (workerSet/staticPool/dynamicPool)
- startDelay: milliseconds to wait at worker threads startup (only for workerSet threads process type)
- elementStartDelay: milliseconds to wait at charging station startup
- elementsPerWorker: number of charging stations per worker threads for the `workerSet` process type
- poolMinSize: worker threads pool minimum number of threads
- poolMaxSize: worker threads pool maximum number of threads
- poolStrategy: worker threads pool [poolifier](https://github.com/poolifier/poolifier) worker choice strategy | -| uiServer | | {
"enabled": true,
"type": "ws",
"options": {
"host: "localhost",
"port": 8080
}
} | {
enabled: boolean;
type: ApplicationProtocol;
options: ServerOptions;
authentication: {
enabled: boolean;
type: AuthenticationType;
username: string;
password: string;
}
} | UI server configuration section | +| uiServer | | {
"enabled": true,
"type": "ws",
"options": {
"host": "localhost",
"port": 8080
}
} | {
enabled: boolean;
type: ApplicationProtocol;
options: ServerOptions;
authentication: {
enabled: boolean;
type: AuthenticationType;
username: string;
password: string;
}
} | UI server configuration section | | performanceStorage | | {
"enabled": false,
"type": "jsonfile",
"file:///performanceRecords.json"
} | {
enabled: boolean;
type: string;
URI: string;
}
where type can be 'jsonfile' or 'mongodb' | performance storage configuration section | | stationTemplateUrls | | {}[] | {
file: string;
numberOfStations: number;
}[] | array of charging station configuration templates URIs configuration section (charging station configuration template file name and number of stations) | -#### Worker process model: +#### Worker process model - **workerSet**: Worker set executing each a static number (elementsPerWorker) of simulated charging stations from the total diff --git a/src/ui/web/README.md b/src/ui/web/README.md index 04d8532a..b14f6e4e 100644 --- a/src/ui/web/README.md +++ b/src/ui/web/README.md @@ -2,7 +2,7 @@ ## Project setup -``` +```shell npm install ``` @@ -12,24 +12,24 @@ For both solution you can then follow the link displayed in the terminal at the #### Compiles and run for production -``` +```shell npm start ``` #### Compiles and run for development -``` +```shell npm run serve ``` ### Compiles and minifies for production -``` +```shell npm run build ``` ### Lints files -``` +```shell npm run lint ``` -- 2.34.1