Skip to content

Commit

Permalink
chore: add devcontainer for local development
Browse files Browse the repository at this point in the history
  • Loading branch information
mrsimonemms committed Aug 6, 2024
1 parent 6e661bf commit 6acce72
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 0 deletions.
11 changes: 11 additions & 0 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"name": "devcontainer",
"image": "ghcr.io/kubefirst/devcontainers/full",
"features": {},
"customizations": {
"vscode": {
"extensions": [],
"settings": {}
}
}
}
6 changes: 6 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,12 @@ Before making a code change, first discuss your idea via an [issue](https://gith

## Getting Started with the Code

### Dev containers

A [.devcontainer](https://containers.dev/) configuration is provided to allow for a full-featured development environment.

### Local development

Kubefirst is created using the [Go Programming Language](https://go.dev). To set up your computer, follow [these steps](https://go.dev/doc/install).

Once Go is installed, you can run Kubefirst from any branch using `go run .`. Go will automatically install the needed modules listed in the [go.mod](go.mod) file. As an example, if you want to create a [local cluster](https://docs.kubefirst.io/kubefirst/local/install.html), the command would be `go run . k3d create`. Note that even if you run kubefirst from `main`, the [gitops-template](https://github.com/kubefirst/gitops-template) version used will be the [latest release](https://github.com/kubefirst/gitops-template/releases). If you also want to use the latest from `main` for the template also, you need to run to use the `--gitops-template-url`, and the `--gitops-template-branch` as follow:
Expand Down

0 comments on commit 6acce72

Please sign in to comment.