Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: fix: readme #54

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: fix: readme #54

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@

KubeEye console is the web interface for [KubeEye](https://github.com/kubesphere/kubeeye).


## Getting Started

Console should be always used with KubeEye, To install kubeeye, please refer to this [README](https://github.com/kubesphere/kubeeye)
Expand Down Expand Up @@ -54,6 +53,12 @@ A KubeEye backend is required to start debugging. You can refer to [Installation

Once the kubeeye is up, you run `yarn dev` to start the development environment.

> If you deploy [KubeEye](https://github.com/kubesphere/kubeeye) and [KubeEye-console](https://github.com/kubesphere/kubeeye-console) on different clusters, you need to copy the `$HOME/.kube/config` file on the KubeEye cluster to the `$HOME/.kube/config` location of the KubeEye-console cluster
>
> Start the `node` and `go` services at the same time
>
> `yarn dev & go run web.go`

## How to submit a PR

Follow [Development Workflow](/docs/development-workflow.md) to commit your codes.
Expand Down