From 007ee6420bb6702c41a277d0712f6e5ea8d6f8c4 Mon Sep 17 00:00:00 2001 From: =?utf8?q?J=C3=A9r=C3=B4me=20Benoit?= Date: Sat, 2 Jul 2022 01:20:28 +0200 Subject: [PATCH] Add more detailled installation instructions MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Close #69 Signed-off-by: Jérôme Benoit --- README.md | 29 ++++++++++++++++++++++------- src/assets/config-template.json | 2 +- 2 files changed, 23 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 441f156b..57d4ab15 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,8 @@ Simple [node.js](https://nodejs.org/) software to simulate a set of charging sta ## Prerequisites +Install the [node.js](https://nodejs.org/) LTS runtime environment: + ### Windows - [Chocolatey](https://chocolatey.org/): @@ -28,6 +30,26 @@ brew install node@16 - [NodeSource](https://github.com/nodesource/distributions) Node.js Binary Distributions for version 16.X +## Installation + +In the repository root, run the following command: + +```shell +npm install +``` + +## Initial configuration + +Copy the configuration template file [src/assets/config-template.json](src/assets/config-template.json) to [src/assets/config.json](src/assets/config.json). +Tweak it to your needs by following the section [charging stations simulator configuration](README.md#charging-stations-simulator-configuration). + +## Start + +To start the program, run: `npm start`. + +To start the program with a UI controller, run: `npm start:server`. +Then, start/stop the simulator by going to `https://` in a browser. Localhost port will default to 8080. For Cloud Foundry, the port is assigned based on the `process.env.PORT` environment variable. + ## Configuration files syntax All configuration files are in the JSON standard format. @@ -241,13 +263,6 @@ The syntax is similar to charging station configuration template with some added The syntax is similar to the charging station configuration template 'Configuration' section. -## Start - -To start the program, run: `npm start`. - -To start the program with a UI controller, run: `npm start:server`. -Then, start/stop the simulator by going to `https://` in a browser. Localhost port will default to 8080. For Cloud Foundry, the port is assigned based on the `process.env.PORT` environment variable. - ## Docker In the [docker](./docker) folder: diff --git a/src/assets/config-template.json b/src/assets/config-template.json index 839750ac..f5595f61 100644 --- a/src/assets/config-template.json +++ b/src/assets/config-template.json @@ -1,6 +1,6 @@ { "supervisionUrls": ["ws://localhost:8010/OCPP16/5be7fb271014d90008992f06"], - "supervisionUrlDistribution": "sequential", + "supervisionUrlDistribution": "round-robin", "performanceStorage": { "enabled": true, "type": "jsonfile" -- 2.34.1