Sulkta-Coop/agora
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

add agora-scripts explainer in README.md

Browse source
This commit is contained in:
Emily Martins 2022-06-29 11:36:13 +02:00
parent be1fd594b6
commit a2f849441f
1 changed files with 12 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -21,6 +21,18 @@ An up to date version of the [Nix package manager](nixos.org) (>=2.3) is require
Open a development shell with `nix develop` and build the project with `cabal build`. Those pained by the need to remember to enter a Nix shell may consider using [nix-direnv](https://github.com/nix-community/nix-direnv).
## `agora-scripts` HTTP export server
To use scripts in a frontend, you can use the `agora-scripts` executable which allows you to query them on-demand.
The CTL repo [`agora-offchain`](https://github.com/mlabs-haskell/agora-offchain) already has the setup prepared for this feature.
In order to run the server, simply run the following command:
```sh
cabal run agora-scripts -- --enable-cors-middleware
```
## Documentation
Documentation for Agora is hosted on Notion. You can find the specs [here](https://liqwid.notion.site/e85c09d2c9a542b19aac8dd3d6caa98b?v=d863219cd6a14082a661c4959cabd6e7).