Merge branch 'dev-setup'

Author: mms-gianni

CONTRIBUTING.md

@@ -1,72 +1,138 @@
 # How to contribute
+> "Great to see you here! We are happy you are considering contributing to Kubero." @mms-gianni
 
-All contributions are welcome. For simple typos, just open a PR.
-For bigger ideas it might be better to open an issue first before you put a lot of work into it. 
+All contributions are welcome. For simple typo's, just open a PR. For bigger ideas/changes we kindly ask you to reach out on discord or open an issue first before you put a lot of work into it. We are very happy to discuss your ideas and help you to get started.
 
-Want to contribute, but don't know where to start? Have a look into the [Roadmap](https://github.com/orgs/kubero-dev/projects/1).
+Willing to contribute something, but you don't know where to start? Have a look into the [Roadmap](https://github.com/orgs/kubero-dev/projects/1). 
 
+## Contribution Process
 1. Setup your development environment
-2. Fork the repository
+2. Fork the repository and checkout the code
 3. Create a new branch
 4. Make your changes
 5. Open a PR
 
+## Techstack
+**Infrastructure**
+- [Kubernetes](https://kubernetes.io/)
+- [Operator SDK](https://sdk.operatorframework.io/)
+- [Helm (Operator)](https://helm.sh/)
+- [Kind (Development)](https://kind.sigs.k8s.io/)
+
+**Code**
+- [Express](https://expressjs.com/)
+- [TypeScript](https://www.typescriptlang.org/)
+- [Vue.js](https://vuejs.org/)
+- [Vuetify](https://vuetifyjs.com/en/)
+
+
 ## Development setup for the Kubero UI
 
 ### Requirements
-- docker
-- kind
-- kubectl
-- kubero-cli
-- git
 
+<<<<<<< HEAD
 
 ### 1) Start a local Kubernetes cluster with Kind
+=======
+To get started with Kubero development, you will need the following toolbelt:
+
+- Docker
+- Kind (Kubernetes in Docker)
+- Kubectl
+- [Kubero CLI](https://github.com/kubero-dev/kubero-cli/releases/latest)
+- Git
+- Code editor of your choice (VSCode, Webstorm, Atom, ...)
+
+### 1) Start a Local Kubernetes Cluster with Kind
+>>>>>>> dev-setup
 Run `kubero install` with the [CLI](https://github.com/kubero-dev/kubero-cli/releases/latest) and select `kind`. 
 This will install a local cluster with a single node and all required components.
 
 You can skip the kubero-UI step since we will use our local code.
 
+<<<<<<< HEAD
 ### 2) Export the kubeconfig
+=======
+### 2) Export the Kubeconfig
+>>>>>>> dev-setup
 ```bash
 kind export kubeconfig --name kubero-XXX --kubeconfig ./kubeconfig
 ```
+This step exports the kubeconfig for your local cluster, making it available for Kubero.
 
+<<<<<<< HEAD
 ### 3) Create a dev namespace
 This step is optional but will avoid interference with the local InCluster kubero-ui instance.
+=======
+### 3) Create a Development Namespace (Optional)
+Although optional, creating a separate namespace helps prevent interference with the local in-cluster Kubero-UI instance.
+>>>>>>> dev-setup
 ```bash
 kubectl create namespace kubero-dev
 ```
 
+<<<<<<< HEAD
 ### 4) Prepare your local code
 Fork the repository https://github.com/kubero-dev/kubero into your account.
 
 Clone your Fork to your local disk.
 
 ### 5) Configure Kubero's environment
+=======
+### 4) Checkout the Code
+1. Fork the [Kubero](https://github.com/kubero-dev/kubero) repository to your GitHub account.
+2. Clone your forked repository to your local machine.
+
+>>>>>>> dev-setup
+```bash
+git clone https://github.com/YOUR_USERNAME/kubero.git
+cd kubero
+```
+
+### 5) Start Your Local Instance
+Navigate to the server directory, and rename the .env.template file to .env to set up the required environment variables.
 ```bash
+cd server
 mv .env.template .env
 ```
 
+<<<<<<< HEAD
 ### 6) Start local node server
 This will start the server part. 
+=======
+Install the dependencies, and start the server:
+>>>>>>> dev-setup
 ```bash
-cd server
 yarn install
 yarn dev
 ```
 
+<<<<<<< HEAD
 Initiate the client JS part. 
+=======
+Next, set up the client JavaScript part:
+>>>>>>> dev-setup
 ```bash
 cd client
 yarn install
 yarn watch
 ```
 
+<<<<<<< HEAD
 You should be able to reach your local dev instance via http://localhost:2000 
 
 ### 7) start optional services 
 If you need any additional services (Gitea, Github ...), just run `docker-compose up -d`, or add it to the `docker-compose.yml` file, if it is missing.
+=======
+You should now be able to access your local development instance at http://localhost:2000 
+
+### 6) Start Additional Services (Optional)
+If you need additional services (such as Gitea or GitHub integration), run the following command to start them via Docker:
+```bash
+docker-compose up -d
+```
+If any services are missing, you can add them to the `docker-compose.yml` file.
+>>>>>>> dev-setup
 
 Nope. No extra database is required. All data is stored in the Kubernetes cluster.