For some background, check the organization page or visit about.zkorum.com.
Install:
All the components run in watch mode.
With gnome-terminal
, you can use the following script to automatically open a terminal with one tab per service and a working tab:
./run_all_in_gnome_terminal_tabs.sh
Otherwise, open four terminals in the root directory, then run the following commands.
Shared tab - automatically rsync shared files to back and front:
make dev-sync
OpenAPI tab - automatically generate frontend stub from backends and subsequent openapi changes:
make dev-generate
Frontend tab:
make dev-front
Backend tab:
make dev-back
... and start coding!
A React PWA.
A Fastify application supported by a PostgreSQL database.
We generate an openapi-zkorum.json
file from the backend, and then use openapi-generator-cli to generate the corresponding front.
Some typescript source files are shared directly without using npm packages - by copy-pasting using rsync.
CLI for ZKorum.
See CONTRIBUTING.md
See COPYING-README