Skip to content

Latest commit

 

History

History
54 lines (40 loc) · 1.23 KB

CONTRIBUTING.md

File metadata and controls

54 lines (40 loc) · 1.23 KB

How to contribute

All contributions are welcome. For simple typos, just open a PR. For bigger ideas it might be better to open a issue first before you put a lot of work into it.

Want to contribute, but dont know where to start? Have a look into the Roadmap.

Development setup

Requirements

  • docker
  • kubectl
  • kubero-cli

Start a cluster

run a kubero install with the CLI and select kind. This will install a local cluster with a single node and all required components.

Export the kubeconfig

kind export kubeconfig --name kubero-XXX --kubeconfig ./kubeconfig

Create a namespace

kubectl create namespace kubero-dev

configure Kubero's environment

mv .env.template .env

Start local node server

yarn install
yarn dev
cd client
npm install
npm run dev

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.

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

How to contribute your code

  1. Fork the repository
  2. Create a new branch
  3. Make your changes
  4. Open a PR