Added some docu content for locally set-up of INOA and Groundcontrol (#…

…129)

Reviewed-on: https://git.grayc.io/inoa/cloud/pulls/129
Reviewed-by: Rico Pahlisch <[email protected]>

.editorconfig

@@ -3,7 +3,7 @@ root = true
 
 [*]
 charset = utf-8
-indent_style = tab
+indent_style = space
 indent_size = 2
 insert_final_newline = true
 trim_trailing_whitespace = true

.gitignore

@@ -4,3 +4,10 @@ app/.angular
 app/.yarn
 app/dist
 app/node_modules
+
+.moquette_uuid
+
+.idea
+*.iml
+
+.vscode

README.md

@@ -1,30 +1,51 @@
-# Inoa IoT Platform
+# INOA IoT Platform
 
-Inoa is a lightweight IoT integration platform that
+INOA is a lightweight IoT integration platform that
 will help you to easily start with your IoT project and offer you the needed infrastructure to develop, deploy, maintain
-and scale your solutions. With Inoa we want to enable users to stay in control of their IoT gateways and measured and/or
+and scale your solutions. With INOA we want to enable users to stay in control of their IoT gateways and measured and/or
 controlled devices.
 
 ## Developer Setup
 
 ### Pre-Requisites
 
+#### Hardware
+
+* >= 32GB RAM
+
+#### Development Tools
+
 * [Git](https://git-scm.com/) >= 2.25
-* [Java Development Kit](https://openjdk.org/install/) >= 17.0.8
+* [Java Development Kit](https://openjdk.org/install/) >= 17.0.8 & < 21
 * [Maven](https://maven.apache.org/) >= 3.6.3
 * [Docker](https://www.docker.com/) >= 24.0.5
 * [k3s](https://k3s.io/)
 * [Python](https://www.python.org/) >= 3.8.5 (for documentation only)
 
+#### Repository Access
+
+* GitHub Container Registry - use `docker login ghcr.io` to initially authenticate against GitHub container registry
+  * `ghcr.io/grayc-de`
+  * `ghcr.io/inoa-io`
+
 ### Start Local Instance
 
-```shell
-mvn k3s:rm
-mvn clean install
-mvn clean pre-integration-test -Dk3s.failIfExists=false -pl ./test/
-```
+1. Build INOA Cloud services and start the whole environment via k3s:
+
+  ```shell
+  mvn k3s:rm
+  mvn clean install
+  mvn clean pre-integration-test -Dk3s.failIfExists=false -pl ./test/
+  ```
+
+1. Check the now running services via [http://help.127.0.0.1.nip.io:8080/](http://help.127.0.0.1.nip.io:8080/).
+1. Start a local instance of INOA Groundcontrol for UI development:
 
-Afterwards, you may browse to [http://help.127.0.0.1.nip.io:8080/](http://help.127.0.0.1.nip.io:8080/).
+  ```shell
+  cd app
+  yarn install
+  ng serve
+  ```
 
 ### Connect INOA Satellite
 
@@ -39,22 +60,22 @@ source tools, it is the cockpit for a fleet of IoT devices.
 
 ### INOA Measurement
 
-INOA Measurements is the place where all the measured data is going in. It collects, stores, enhances measurments that
+INOA Measurements is the place where all the measured data is going in. It collects, stores, enhances measurements that
 are collected by IoT devices and provide it with help of APIs and UIs.
 
 ### INOA Groundcontrol
 
-see [Ground-Control README](inoa-groundcontrol/README.md)
+INOA Groundcontrol is the UI to manage the IoT Fleet with INOA.
 
 ### INOA OS
 
-INOA OS is our operating system for Inoa connected IoT devices and gateways.
+INOA OS is our operating system for INOA connected IoT devices and gateways.
 
 Please find the documentation [here](https://inoa-io.github.io/inoa-os-esp32/).
 
 ### INOA Satellite
 
-The INOA-Satellite is small IoT gateway made for gathering various of different measurements and forwarding them to Inoa
+The INOA-Satellite is a small IoT gateway made for gathering various of different measurements and forwarding them to Inoa
 Measurement.
 
 Please find the documentation [here](https://inoa-io.github.io/satellite/).