You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: govtool/backend/README.md
+30-14Lines changed: 30 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,9 +5,10 @@ This is a backend application of GovTool project.
5
5
## Prerequisites
6
6
7
7
In order to run `backend` your host machine will need access to the `cardano-db-sync` postgres database. To have this database running locally you'll need:
8
-
*`cardano-node`
9
-
*`cardano-db-sync`
10
-
* PostgreSQL database
8
+
9
+
-`cardano-node`
10
+
-`cardano-db-sync`
11
+
- PostgreSQL database
11
12
12
13
You will need your `cardano-node` and `cardano-db-sync` to be compatible with Sancho testnet. Until these features will be merged to the master branch the new Sancho compatible versions are available as releases on [github](https://github.com/IntersectMBO/cardano-db-sync/releases). You will also need a correct `cardano-node` version. The release notes for `cardano-db-sync` usualy specify that.
13
14
@@ -25,35 +26,50 @@ You can utilize the [docker-compose.node+dbsync.yml](../../scripts/govtool/docke
25
26
26
27
Due to problems with openapi3 package it's hard to build this project with plain `ghc` and `cabal-install`. Until the prolem is solved we reccomend using `nix` - this problem is fixed when you build your project from inside of the nix shell.
27
28
28
-
1. Get [Nix](https://nixos.org/download).
29
+
1. Get [Nix](https://nixos.org/download).
30
+
31
+
2. Get [direnv](https://direnv.net/).
32
+
33
+
3. Set GHC version to 9.10.1:
34
+
35
+
```sh
36
+
ghcup install ghc 9.10.1
37
+
38
+
ghcup set ghc 9.10.1
39
+
```
40
+
41
+
4. Install cabal
29
42
30
-
2. Get [direnv](https://direnv.net/).
43
+
```sh
44
+
ghcup install cabal
45
+
ghcup set cabal
46
+
```
31
47
32
-
3. Enter `govtool/backend` directory:
48
+
5. Enter `govtool/backend` directory:
33
49
34
50
```sh
35
51
cd govtool/backend
36
52
```
37
53
38
-
4. Allow direnv to setup your environment:
54
+
6. Allow direnv to setup your environment:
39
55
40
56
```sh
41
57
direnv allow
42
58
```
43
59
44
-
5. Update cabal & build project
60
+
7. Update cabal & build project
45
61
```sh
46
62
cabal update
47
63
cabal build all
48
64
```
49
-
6. Create a config file. You can use `example-config.json` as a template.
65
+
8. Create a config file. You can use `example-config.json` as a template.
50
66
51
-
7. Run project
52
-
```sh
67
+
9. Run project
68
+
`sh
53
69
cabal run vva-be -- --config <YOUR CONFIG FILE> start-app
54
-
```
55
-
> [!WARNING]
56
-
> In the context of our ongoing project enhancements, it is assumed that the executable previously known as 'vva-be' should be now officially renamed to 'govtool-backend'. This change is necessary foraligning with the updated branding and functional scope of the application and it has to be implementedin the near future as a chore and refactoring ticket. Make sure that the documentation matches the actual name of the executable.
70
+
`
71
+
> [!WARNING]
72
+
> In the context of our ongoing project enhancements, it is assumed that the executable previously known as 'vva-be' should be now officially renamed to 'govtool-backend'. This change is necessary foraligning with the updated branding and functional scope of the application and it has to be implementedin the near future as a chore and refactoring ticket. Make sure that the documentation matches the actual name of the executable.
0 commit comments