Skip to content

Commit 6fc73f0

Browse files
authored
Update CONTRIBUTING.md (#438)
1 parent 26fb37b commit 6fc73f0

File tree

1 file changed

+15
-8
lines changed

1 file changed

+15
-8
lines changed

CONTRIBUTING.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,45 +20,52 @@ Want to contribute, but don't know where to start? Have a look into the [Roadmap
2020
- kubero-cli
2121
- git
2222

23-
### 1) prepare your local code
24-
Fork the repository https://github.com/kubero-dev/kubero into your account.
2523

26-
### 2) Start a cluster
24+
### 1) Start a local Kubernetes cluster with Kind
2725
Run `kubero install` with the [CLI](https://github.com/kubero-dev/kubero-cli/releases/latest) and select `kind`.
2826
This will install a local cluster with a single node and all required components.
2927

3028
You can skip the kubero-UI step since we will use our local code.
3129

32-
### 3) Export the kubeconfig
30+
### 2) Export the kubeconfig
3331
```bash
3432
kind export kubeconfig --name kubero-XXX --kubeconfig ./kubeconfig
3533
```
3634

37-
### Create a dev namespace
35+
### 3) Create a dev namespace
3836
This step is optional but will avoid interference with the local InCluster kubero-ui instance.
3937
```bash
4038
kubectl create namespace kubero-dev
4139
```
4240

43-
### Configure Kubero's environment
41+
### 4) Prepare your local code
42+
Fork the repository https://github.com/kubero-dev/kubero into your account.
43+
44+
Clone your Fork to your local disk.
45+
46+
### 5) Configure Kubero's environment
4447
```bash
4548
mv .env.template .env
4649
```
4750

48-
### Start local node server
51+
### 6) Start local node server
52+
This will start the server part.
4953
```bash
5054
cd server
5155
yarn install
5256
yarn dev
5357
```
5458

59+
Initiate the client JS part.
5560
```bash
5661
cd client
5762
yarn install
5863
yarn watch
5964
```
6065

61-
### start optional services
66+
You should be able to reach your local dev instance via http://localhost:2000
67+
68+
### 7) start optional services
6269
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.
6370

6471
Nope. No extra database is required. All data is stored in the Kubernetes cluster.

0 commit comments

Comments
 (0)