From b5d112a05d5b62a10ab68ee5eef9132f5cea23a4 Mon Sep 17 00:00:00 2001 From: Apostolof Date: Sat, 21 Nov 2020 22:14:33 +0200 Subject: [PATCH] Add main README.md, Init docker README.md --- README.md | 37 +++++++++++++++++++++++++++++++++++++ docker/README.md | 32 ++++++++++++++++++++++++++++++++ 2 files changed, 69 insertions(+) create mode 100644 README.md create mode 100644 docker/README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..97b0b0c --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +# Concordia +> A distributed forum using Blockchain, supporting direct democratic voting + +## Setup + +```shell script +cd apella +yarn +``` + +## Compile contracts + +```shell script +cd packages/apella-contracts +yarn compile +``` + +## Run app + +```shell script +cd packages/apella-app +yarn start +``` + +## Build app + +```shell script +cd packages/apella-app +yarn build +``` + +## Using Docker images + +This project provides docker images for a number of services required to setup Concordia, as well as for Concordia +itself. + +Check out the README.md in the `./docker` directory diff --git a/docker/README.md b/docker/README.md new file mode 100644 index 0000000..c258cf6 --- /dev/null +++ b/docker/README.md @@ -0,0 +1,32 @@ +# Concordia Docker Images + +## Dockerfiles provided + +Concordia uses blockchain and other distributed technologies. There are a number of ways to setup a running instance of +this application. + +This README will guide you through a testing setup that depends on a local blockchain (ganache) which does not require +real ETH to work or has any other charges. + +For this configuration the services needed are: + +- A blockchain (ganache) +- A server that helps peers connect and route their messages to other (rendezvous) +- A service or provision system to compile and deploy the contracts to the blockchain (concordia-contracts image) +- An HTML server that provides access to the Concordia application (concordia-app image) + +This repo provides Dockerfiles for all the above services. + +## Concordia Contracts Image + +Makefile +-> build contracts +-> build migrate +-> build tests +-> get contracts out +-> run tests +-> run migrate + +env files + +## Concordia Application Image