From e375d45e022f004f959ba89d53a9e643f9529b68 Mon Sep 17 00:00:00 2001 From: Ulf Gebhardt Date: Fri, 29 Oct 2021 22:37:46 +0200 Subject: [PATCH 1/2] updated readme: - accurate software requirements - arch linux install instructions - service description - troubleshooting --- README.md | 66 ++++++++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 53 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index fe6f2e7f3..708bd6521 100644 --- a/README.md +++ b/README.md @@ -8,33 +8,73 @@ The Gradido model can create global prosperity and peace The Corona crisis has fundamentally changed our world within a very short time. The dominant financial system threatens to fail around the globe, followed by mass insolvencies, record unemployment and abject poverty. Only with a sustainable new monetary system can humanity master these challenges of the 21st century. The Gradido Academy for Bionic Economy has developed such a system. +Find out more about the Project on its [Website](https://gradido.net/) offering vast resources about the idea. The remaining document will discuss the gradido software only. ## Software requirements -Currently we only support `docker` as environment to run all services, since many different programming languages and frameworks are used. +Currently we only support `docker` install instructions to run all services, since many different programming languages and frameworks are used. -- [docker](https://www.docker.com/) +- [docker](https://www.docker.com/) +- [docker-compose] + +### For Arch Linux +Install the required packages: +```bash +sudo pacman -S docker +sudo pacman -S docker-compose +``` + +Add group `docker` and then your user to it in oder to allow you to run docker without sudo +```bash +sudo groupadd docker # may already exist `groupadd: group 'docker' already exists` +sudo usermod -aG docker $USER +groups # verify you have the group (requires relog) +``` + +Start the docker service: +```bash +sudo systemctrl start docker +``` ## How to run? -1. Clone the repo and pull all submodules - +### 1. Clone Sources +Clone the repo and pull all submodules ```bash git clone git@github.com:gradido/gradido.git git submodule update --recursive --init ``` -2. Run docker compose - 1. Run docker compose for the debug build +### 2. Run docker-compose +Run docker-compose to bring up the development environment +```bash +docker-compose up +``` +### Additional Build options +If you want to build for production you can do this aswell: +```bash +docker-compose -f docker-compose.yml up +``` - ```bash - docker-compose up - ``` +## Services defined in this package - 2. Or run docker compose in production build +- [frontend](./frontend) Wallet frontend +- [backend](./backend) GraphQL & Business logic backend +- [mariadb](./mariadb) Database backend +- [login_server](./login_server) User credential storage & business logic backend +- [community_server](./community_server/) Business logic backend - ```bash - docker-compose -f docker-compose.yml up - ``` +We are currently restructuring the service to reduce dependencies and unify business logic into one place. Furthermore the databases defined for each service will be unified into one. + +### Open the wallet + +Once you have `docker-compose` up and running, you can open [http://localhost/vue](http://localhost/vue) and create yourself a new wallet account. + +## Troubleshooting + +| Problem | Issue | Solution | Description | +| ------- | ----- | -------- | ----------- | +| docker-compose raises database connection errors | [#1062](https://github.com/gradido/gradido/issues/1062) | End `ctrl+c` and restart the `docker-compose up` after a successful build | Several Database connection related errors occur in the docker-compose log. | +| Wallet page is empty | [#1063](https://github.com/gradido/gradido/issues/1063) | Accept Cookies and Local Storage in your Browser | The page stays empty when navigating to [http://localhost/vue](http://localhost/vue) | ## Useful Links From f3a1ebb66bcd7f846b936c3f56549cc07ca59b30 Mon Sep 17 00:00:00 2001 From: Ulf Gebhardt Date: Fri, 29 Oct 2021 22:46:16 +0200 Subject: [PATCH 2/2] spelling --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 708bd6521..ead54701c 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ The Gradido model can create global prosperity and peace The Corona crisis has fundamentally changed our world within a very short time. The dominant financial system threatens to fail around the globe, followed by mass insolvencies, record unemployment and abject poverty. Only with a sustainable new monetary system can humanity master these challenges of the 21st century. The Gradido Academy for Bionic Economy has developed such a system. -Find out more about the Project on its [Website](https://gradido.net/) offering vast resources about the idea. The remaining document will discuss the gradido software only. +Find out more about the Project on its [Website](https://gradido.net/). It is offering vast resources about the idea. The remaining document will discuss the gradido software only. ## Software requirements Currently we only support `docker` install instructions to run all services, since many different programming languages and frameworks are used. @@ -23,7 +23,7 @@ sudo pacman -S docker sudo pacman -S docker-compose ``` -Add group `docker` and then your user to it in oder to allow you to run docker without sudo +Add group `docker` and then your user to it in order to allow you to run docker without sudo ```bash sudo groupadd docker # may already exist `groupadd: group 'docker' already exists` sudo usermod -aG docker $USER