Development Environment

We're really excited that you are interested in contributing to Kloud Workspace. Before submitting your contribution, please make sure to take a moment and read through the following guidelines:

• Code of Conduct →
• Contribution Workflow (Optional) →

Prerequisites

Before you begin, check your prerequisites meet the minimum requirements versions:

• Python (optional): >=3.8
• NodeJS (docs): >=18
• Golang (cli): >=1.21

Python

$ python --version
Python 3.11.2

NodeJS

$ node --version
v22.11.0

Golang

$ go version
go version go1.23.3 linux/amd64

Setup

You can clone the repository and run it locally:

1. Clone the repository

Workspace

git clone https://github.com/kloudkit/workspace

Documentation

git clone https://github.com/kloudkit/workspace-docs

CLI

git clone https://github.com/kloudkit/ws-cli

2. Install dependencies

Linting (optional)

pip install pre-commit

Documentation

yarn install

CLI

go install

3. Linting (Optional)

pre-commit run --all-files
pre-commit install

TIP

This step is automatically run on all PRs and commits. If you choose to skip this step, thats OK, we will run it for you during CI.

4. Run a local development (docs) server

yarn run docs:dev