From bf3d49ea95c6f5af4bf0163ae221c1163ba7468b Mon Sep 17 00:00:00 2001 From: Juan Ferrer Toribio <juan@verdnatura.es> Date: Tue, 16 Aug 2022 13:45:51 +0200 Subject: [PATCH] Documentation improved --- README.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c4cfb4d..14136b4 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,27 @@ # Asynchronous DB calculations reading the binary log -Clone *zongji* repo into project directory. +## Enviroment setup + +Because a bug with MariaDB wich it's fix is pending to be merged into main +project branch, a *zongji* fork must be cloned into project root directory. +More info at https://github.com/nevill/zongji/issues/143 ```text git clone https://github.com/juan-ferrer-toribio/zongji.git cd zongji git checkout fix-143 ``` +Apply SQL commands from *zongji.sql* into DB. + +Copy *config.json* to *config.local.json* and place your local configuration +there. + Install dependencies. ```text -npm i +npm install ``` -Apply SQL commands from *zongji.sql* into DB. +## Run application Launch app. ```text