docs: fixed command line instructions

cardano-foundation · Nov 30, 2023 · c0d66f5 · c0d66f5
1 parent c544fb4
commit c0d66f5
Show file tree

Hide file tree

Showing 5 changed files with 580 additions and 527 deletions.
diff --git a/README.md b/README.md
@@ -75,7 +75,7 @@ from database constructs merkle tree and at periodic, configurable intervals sen
 By default all backend apps are working with Cardano Pre-Production network.
 
 ```shell
-cd cf-ballot-app/backend-services/voting-admin-app
+cd cf-cardano-ballot/backend-services/voting-admin-app
 ./gradlew bootRun
 ```
 
@@ -86,7 +86,7 @@ Instructions on how to create a new voting event can be found [here](./backend-s
 By default all backend apps are working with Cardano Pre-Production network.
 
 ```shell
-cd cf-ballot-app/backend-services/voting-ledger-follower-app
+cd cf-cardano-ballot/backend-services/voting-ledger-follower-app
 ./gradlew bootRun
 ```
 This will launch main voting-ledger-follower-app on port: 9090 by default.
@@ -95,7 +95,7 @@ For a detailed description and interactive interface of the API, visit the Swagg
 
 ### Voting App
 ```shell
-cd cf-ballot-app/backend-services/voting-app
+cd cf-cardano-ballot/backend-services/voting-app
 ./gradlew bootRun
 ```
 
@@ -105,7 +105,7 @@ For a detailed description and interactive interface of the API, visit the Swagg
 
 ### Voting Verification
 ```shell
-cd cf-ballot-app/backend-services/voting-verification-app
+cd cf-cardano-ballot/backend-services/voting-verification-app
 ./gradlew bootRun
 ```
 
@@ -117,8 +117,7 @@ Instructions on how to run the `Vote Verification` app can be found [here](./bac
 
 ### Voting Commitment App
 ```bash
-git clone https://github.com/cardano-foundation/vote-commitment-service.git
-cd vote-commitment-service
+cd cf-cardano-ballot/backend-services/vote-commitment-app
 cp .env.template .env
 # Update .env with required values (e.g. organiser's mnemonic)
 # Run the service locally via:
@@ -129,7 +128,7 @@ cp .env.template .env
 ```bash
 export AWS_SNS_ACCESS_KEY_ID=...
 export AWS_SNS_SECRET_ACCESS_KEY=...
-cd cf-ballot-app/backend-services/user-verification-service
+cd cf-cardano-ballot/backend-services/user-verification-service
 ./gradlew bootRun
 ```
 
@@ -153,7 +152,8 @@ Copy the [`.env.example`](ui/summit-2023/.env.example) file and rename it as `.e
 Then run:
 
 ```shell
-cd cf-ballot-app/ui/summit-2023
+cd cf-cardano-ballot/ui/summit-2023
+cp .env.example .env
 npm i
 npm run start
 ```
@@ -163,7 +163,7 @@ All backend apps will generate TypeScript types for the frontend by using the fo
 
 As an example:
 ```shell
-cd voting-app
+cd cf-cardano-ballot/backend-services/voting-app
 ./gradlew buildAndCopyTypescriptTypes -Pui_project_name=summit-2023
 ```
 This will generate TypeScript types in the ui/summit-2023/build/typescript-generator/voting-app-types.ts

diff --git a/backend-services/vote-commitment-app/README.md b/backend-services/vote-commitment-app/README.md
@@ -35,8 +35,7 @@ at different time intervals).
 
 ### Development
 ```bash
-git clone https://github.com/cardano-foundation/vote-commitment-service.git
-cd vote-commitment-service
+cd cf-cardano-ballot/backend-services/vote-commitment-app
 cp .env.template .env
 # Update .env with required values (e.g. organiser's mnemonic)
 # Run the service locally via:

diff --git a/backend-services/voting-admin-app/README.md b/backend-services/voting-admin-app/README.md
@@ -5,6 +5,7 @@ Application to be used by the organisers to create events and proposals.
 
 # Run in docker
 ```
+cd cf-cardano-ballot/backend-services/voting-admin-app
 docker run -it --rm \
   -e SPRING_PROFILES_ACTIVE=prod \
   -e CARDANO_NETWORK=main \

diff --git a/ui/summit-2023/README.md b/ui/summit-2023/README.md
@@ -25,6 +25,14 @@ In the project directory, you can run:
 
 This will install all packages in node_modules folder.
 
+### Create a .env file
+
+Before running the app you need to create a .env file by executing the following command:
+
+```bash
+cp .env.example .env
+```
+
 #### `npm start`
 
 Runs the app in the development mode.\
@@ -46,31 +54,30 @@ Your app is ready to be deployed!
 To run the backend services you will need to open multiple terminals and follow this instructions:
 
 ### Terminal 1 - [Data follower app](/backend-services/vote-commitment-app/) on port: 9090
-Edit ``application.properties``:
-1. Comment CIP-1694 Pre Ratification start block.
-2. Uncomment CF Summit 2023 start block
+
 ```bash
-cd voting-ledger-follower-app
+cd cf-cardano-ballot/backend-services/voting-ledger-follower-app
 ./gradlew bootRun
-
 ```
 ### Terminal 2 - [Voting app](/backend-services/voting-app/) on port: 9091
 ```bash
-cd voting-app
+cd cf-cardano-ballot/backend-services/voting-app
 ./gradlew bootRun
 ```
 
 ### Terminal 3 - [Vote verification app](/backend-services/voting-verification-app/) on port: 9092
 ```bash
-cd voting-verification-app
+cd cf-cardano-ballot/backend-services/voting-verification-app
 ./gradlew bootRun
 ```
 
 ### Terminal 4 - [User verification app](/backend-services/user-verification-service/) on port: 9093
+
+To run this service you need to provide your own AWS credentials to enable the sms verification service.
 ```bash
 export AWS_SNS_ACCESS_KEY_ID=...
 export AWS_SNS_SECRET_ACCESS_KEY=...
-cd user-verification-service
+cd cf-cardano-ballot/backend-services/user-verification-service
 ./gradlew bootRun
 ```