Merge pull request #1842 from gradido/1823-Describe_Setup_on_Windows

more details about Windows installation

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