Documentation improved

This commit is contained in:
Juan Ferrer 2022-08-16 13:45:51 +02:00
parent 2eb72ec258
commit bf3d49ea95
1 changed files with 12 additions and 3 deletions

View File

@ -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