Documentation improved
This commit is contained in:
parent
2eb72ec258
commit
bf3d49ea95
15
README.md
15
README.md
|
@ -1,18 +1,27 @@
|
||||||
# Asynchronous DB calculations reading the binary log
|
# 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
|
```text
|
||||||
git clone https://github.com/juan-ferrer-toribio/zongji.git
|
git clone https://github.com/juan-ferrer-toribio/zongji.git
|
||||||
cd zongji
|
cd zongji
|
||||||
git checkout fix-143
|
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.
|
Install dependencies.
|
||||||
```text
|
```text
|
||||||
npm i
|
npm install
|
||||||
```
|
```
|
||||||
|
|
||||||
Apply SQL commands from *zongji.sql* into DB.
|
## Run application
|
||||||
|
|
||||||
Launch app.
|
Launch app.
|
||||||
```text
|
```text
|
||||||
|
|
Loading…
Reference in New Issue