Create a local setup with GoTask and Compose v2

.env.dist

@@ -2,8 +2,14 @@ REPOSITORIES=NINETOFIVER,YAYATA
 
 NINETOFIVER_DIRECTORY="../925r"
 NINETOFIVER_URL="https://github.com/inuits/925r.git"
-NINETOFIVER_BRANCH="master"
+NINETOFIVER_BRANCH="feature/metalarend/local-setup"
 
 YAYATA_DIRECTORY="../yayata"
 YAYATA_URL="https://github.com/inuits/yayata.git"
-YAYATA_BRANCH="master"
+YAYATA_BRANCH="feature/metalarend/local-setup"
+
+K3D_REGISTRY_HOST=registry.localhost
+K3D_REGISTRY_PORT=5000
+K3D_CLUSTER_NAME=yayata-cluster
+K3D_CLUSTER_PORT_MAP=80:80@loadbalancer
+KUBERNETES_NAMESPACE_NAME=yayata

.gitignore

@@ -1,2 +1,3 @@
 /.env
 /.env.bck
+/.task

README.md

@@ -1,27 +1,90 @@
 # yayata-common
 
-Repository for locally bootstrapping YaYata and 925r.
+Repository for locally bootstrapping 925r and Yayata.
 
 ## Dependencies
 
-- [Taskfile](https://taskfile.dev/)
-- [Docker Compose plugin](https://docs.docker.com/compose/)
+- [Git](https://git-scm.com/) - [Installation](https://git-scm.com/download/linux)
+- [Taskfile](https://taskfile.dev/) - [Installation](https://taskfile.dev/installation/#install-script)
+- [Docker with Compose v2](https://docs.docker.com/compose/) - [Installation](https://docs.docker.com/compose/install/linux/)
 
-## Run
+## Installation
 
-Run script to clone required repositories.
+Create a new directory for all [925r](https://github.com/inuits/925r) and [Yayata](https://github.com/inuits/yayata) repositories to live in:
 
-```shell
+```
+mkdir -p ~/inuits/yayata-application
+```
+
+Step inside the newly created directory.
+
+```
+cd ~/inuits/yayata-application
+```
+
+Clone this repository from [GitHub](https://github.com/inuits/yayata-common):
+
+```
+git clone --branch feature/metalarend/local-setup --single-branch https://github.com/inuits/yayata-common.git
+```
+
+Step inside the newly pulled directory.
+
+```
+cd yayata-common
+```
+
+Clone the 925r and Yayata repositories:
+
+```
 task clone
 ```
 
-Start the setup. This will hand off the actual actions to both repositories.
+## Update
+
+Pull the latest changes from the 925r and Yayata repositories:
+
+```
+task pull
+```
+
+## Configuration
+
+Make sure to set up the .env files.
+
+Change the COMPOSE_FILE variable, to make sure either the ports are fixed,
+or use Traefik to connect to the service.
 
-```shell
+## Usage
+
+### Compose
+
+Start both 925r and Yayata:
+
+```
 task start
 ```
+
+Open your browser on [http://localhost:8000](http://localhost:8000) for the 925r application.
+
+Open your browser on [http://localhost:8080](http://localhost:8080) for the Yayata application.
+
+The credentials for Yayata can be found in the 925r .env file.
+
+For more details, check the 925r and Yayata README.md files.
+
+### Kubernetes
+
+Start both 925r and Yayata:
+
+```
+task v2:start
+```
+
+Open your browser on [http://ninetofiver.localhost](http://ninetofiver.localhost) for the 925r application.
+
+Open your browser on [http://yayata.localhost](http://yayata.localhost) for the Yayata application.
 
-Open your browser on [http://localhost:8080](http://localhost:8080) and
-login to YaYata with the credentials found in the YaYata .env file.
+The credentials for Yayata can be found in the 925r .env file.
 
-For more details, check the YaYata or 925r README.md files.
+For more details, check the 925r and Yayata README.md files.