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
+17-17Lines changed: 17 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,9 +6,9 @@ This is a backend application of GovTool project.
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:
-[PostgreSQL database](https://www.postgresql.org/download/) (psql needs to be installed on your machine in order to compile the project)
12
12
13
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.
14
14
@@ -30,44 +30,44 @@ Due to problems with openapi3 package it's hard to build this project with plain
30
30
31
31
2. Get [direnv](https://direnv.net/).
32
32
33
-
3. Set GHC version to 9.10.1:
33
+
3. Set GHC version to 9.2.8:
34
34
35
35
```sh
36
-
ghcup install ghc 9.10.1
36
+
ghcup install ghc 9.2.8
37
37
38
-
ghcup set ghc 9.10.1
38
+
ghcup set ghc 9.2.8
39
39
```
40
40
41
41
4. Install cabal
42
42
43
-
```sh
44
-
ghcup install cabal
45
-
ghcup set cabal
46
-
```
43
+
```sh
44
+
ghcup install cabal
45
+
ghcup set cabal
46
+
```
47
47
48
48
5. Enter `govtool/backend` directory:
49
49
50
50
```sh
51
-
cd govtool/backend
51
+
cd govtool/backend
52
52
```
53
53
54
54
6. Allow direnv to setup your environment:
55
55
56
56
```sh
57
-
direnv allow
57
+
direnv allow
58
58
```
59
59
60
60
7. Update cabal & build project
61
61
```sh
62
-
cabal update
63
-
cabal build all
62
+
cabal update
63
+
cabal build all
64
64
```
65
65
8. Create a config file. You can use `example-config.json` as a template.
66
66
67
67
9. Run project
68
-
`sh
69
-
cabal run vva-be -- --config <YOUR CONFIG FILE> start-app
70
-
`
68
+
```sh
69
+
cabal run vva-be -- --config <YOUR CONFIG FILE> start-app
70
+
```
71
71
> [!WARNING]
72
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