Skip to content

zkorum/agora

Folders and files

NameName
Last commit message
Last commit date
May 16, 2024
Nov 9, 2024
Dec 23, 2023
Dec 24, 2024
Mar 21, 2025
Nov 20, 2024
Nov 9, 2024
Oct 6, 2023
Jul 13, 2023
Mar 10, 2025
Nov 14, 2024
Jan 9, 2025
Dec 31, 2024
Sep 24, 2024

Repository files navigation

Agora Citizen Network

Monorepo for Agora Citizen Network.

Development

Prerequisites

Install:

Run in dev mode

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!

Services

Agora

A Quasar application (frontend)

Api

A Fastify application supported by a PostgreSQL database (backend).

OpenAPI

We generate an openapi-zkorum.json file from the backend, and then use openapi-generator-cli to generate the corresponding front.

Shared

Some typescript source files are shared directly without using npm packages - by copy-pasting using rsync.

Security disclosures

If you discover any security issues, please send an email to [email protected]. The email is automatically CCed to the entire team, and we'll respond promptly. See SECURITY for more info.

Contributing

See CONTRIBUTING.md

License

See COPYING-README

Acknowledgements

NGI

This project has received funding from the European Union's Horizon Europe 2020 research and innovation program through the NGI TRUSTCHAIN program under cascade funding agreement No. 101093274 and the NGI SARGASSO project under grant agreement No. 101092887.

In terms of source code, the NGI SARGASSO program exclusively funded the integration with Rarimo. For detailed information, please refer to the commit messages and file headers.