Skip to content

Commit c93b513

Browse files
committed
update: main README - add section on how to run a demo
1 parent 0d94952 commit c93b513

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,21 @@ see https://github.com/alexscheitlin/master-project-sink/pull/30 for more detail
5757

5858
![modules](./assets/eVoting.svg)
5959

60-
## How to run
60+
## How To Run A Demo!
61+
62+
To run a demo of the project with one voting authority and three sealers use the following command.
63+
64+
```bash
65+
./docker-prebuilt-up.sh
66+
```
67+
68+
Once the demo is finished, everything can be shutdown with the following command:
69+
70+
```bash
71+
./docker-prebuilt-down.sh
72+
```
73+
74+
## How To Run The Project (in detail -> more for development)
6175

6276
Each subproject is configured to set and wire the PORTS automatically for every service that this subproject needs. For example: with `sealer/docker-start.sh`, the needed environment variables are fetched from `system.json` and written to `.env` files. These `.env` files are then used in `docker-compose.yml`.
6377

0 commit comments

Comments
 (0)