From 69ec59651fd047fda8ce09d103b36624e60c6223 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Claus-Peter=20H=C3=BCbner?= Date: Wed, 27 Apr 2022 02:03:53 +0200 Subject: [PATCH 1/5] more details about Windows installation --- README.md | 50 ++++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 44 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index e97055a78..8bfff0f25 100644 --- a/README.md +++ b/README.md @@ -9,21 +9,26 @@ 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/). 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. -- [docker](https://www.docker.com/) +- [docker](https://www.docker.com/) - [docker-compose] +- [yarn](https://phoenixnap.com/kb/yarn-windows) ### 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 order 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 @@ -31,26 +36,58 @@ groups # verify you have the group (requires relog) ``` Start the docker service: + ```bash sudo systemctrl start docker ``` +### For Windows + +#### docker + +The installation of dockers depends on your selected product package from the [dockers page](https://www.docker.com/). For windows the product *docker desktop* will be the choice. Please follow the installation instruction of your selected product. + +##### known problems + +* In case the docker desktop will not start correctly because of previous docker installations, then please clean the used directories of previous docker installation - `C:\Users` - before you retry starting docker desktop. For further problems executing docker desktop please take a look in this description "[logs and trouble shooting](https://docs.docker.com/desktop/windows/troubleshoot/)" +* In case your docker desktop installation causes high memory consumption per vmmem process, then please take a look at this description "[vmmen process consuming too much memory (Docker Desktop)](https://dev.to/tallesl/vmmen-process-consuming-too-much-memory-docker-desktop-273p)" + +#### yarn + +For the Gradido build process the yarn package manager will be used. Please download and install [yarn for windows](https://phoenixnap.com/kb/yarn-windows) by following the instructions there. + ## How to run? +As soon as the software requirements are fulfilled and a docker installation is up and running then open a powershell on Windows or an other commandline prompt on Linux. + +Create and navigate to the directory, where you want to create the Gradido runtime environment. + +``` +mkdir \Gradido +cd \Gradido +``` + ### 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 -Run docker-compose to bring up the development environment + +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 ``` @@ -73,6 +110,7 @@ A release is tagged on Github by its version number and published as github rele Each release is accompanied with release notes automatically generated from the git log which is available as [CHANGELOG.md](./CHANGELOG.md). To generate the Changelog and set a new Version you should use the following commands in the main folder + ```bash git fetch --all yarn release @@ -85,10 +123,10 @@ Note: The Changelog will be regenerated with all tags on release on the external ## Troubleshooting -| Problem | Issue | Solution | Description | -| ------- | ----- | -------- | ----------- | +| 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/](http://localhost/) | +| 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/](http://localhost/) | ## Useful Links From 0a480f3a2e2e62fb0c6a8ecbe9595829496b8a4f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Claus-Peter=20H=C3=BCbner?= Date: Wed, 27 Apr 2022 02:23:18 +0200 Subject: [PATCH 2/5] exclude some local settings from git --- .gitignore | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.gitignore b/.gitignore index b02b9d6ec..ac2e485d2 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,6 @@ +.dbeaver +.project +.vscode *.log /node_modules/* messages.pot From bdfd71569e111e50e977a54fc764b129047ae0ac Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Claus-Peter=20H=C3=BCbner?= Date: Wed, 27 Apr 2022 02:24:10 +0200 Subject: [PATCH 3/5] untrack local vscode extensions --- .vscode/extensions.json | 8 -------- 1 file changed, 8 deletions(-) delete mode 100644 .vscode/extensions.json diff --git a/.vscode/extensions.json b/.vscode/extensions.json deleted file mode 100644 index 9b0d3b79e..000000000 --- a/.vscode/extensions.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "recommendations": [ - "streetsidesoftware.code-spell-checker", - "dbaeumer.vscode-eslint", - "esbenp.prettier-vscode", - "hediet.vscode-drawio" - ] -} \ No newline at end of file From 9ab2e2f1a3d442bde4b092f835d9d6e4dbc4ad34 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Claus-Peter=20H=C3=BCbner?= Date: Fri, 29 Apr 2022 04:06:21 +0200 Subject: [PATCH 4/5] Revert "untrack local vscode extensions" This reverts commit bdfd71569e111e50e977a54fc764b129047ae0ac. --- .vscode/extensions.json | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 .vscode/extensions.json diff --git a/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 000000000..9b0d3b79e --- /dev/null +++ b/.vscode/extensions.json @@ -0,0 +1,8 @@ +{ + "recommendations": [ + "streetsidesoftware.code-spell-checker", + "dbaeumer.vscode-eslint", + "esbenp.prettier-vscode", + "hediet.vscode-drawio" + ] +} \ No newline at end of file From 04c1f33dc495d69b0afa5067cdd6d11c3cb17cde Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Claus-Peter=20H=C3=BCbner?= Date: Fri, 29 Apr 2022 04:10:39 +0200 Subject: [PATCH 5/5] remove .vscode from .gitignore --- .gitignore | 1 - 1 file changed, 1 deletion(-) diff --git a/.gitignore b/.gitignore index ac2e485d2..32e11f545 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,5 @@ .dbeaver .project -.vscode *.log /node_modules/* messages.pot