{"id":17604284,"url":"https://github.com/kubesphere/console","last_synced_at":"2025-05-14T04:07:39.162Z","repository":{"id":37406244,"uuid":"224581351","full_name":"kubesphere/console","owner":"kubesphere","description":"KubeSphere Console is the web-based UI for KubeSphere clusters.","archived":false,"fork":false,"pushed_at":"2025-05-06T07:10:59.000Z","size":72368,"stargazers_count":606,"open_issues_count":203,"forks_count":463,"subscribers_count":17,"default_branch":"master","last_synced_at":"2025-05-06T08:26:47.383Z","etag":null,"topics":["console","container","dashboard","hacktoberfest","kubernetes","kubesphere"],"latest_commit_sha":null,"homepage":"https://kubesphere.io","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kubesphere.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"docs/code-of-conduct.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS","dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2019-11-28T06:04:21.000Z","updated_at":"2025-04-24T08:36:01.000Z","dependencies_parsed_at":"2025-01-09T01:32:32.246Z","dependency_job_id":"4127e956-c40c-4d32-92b4-5aad654746ae","html_url":"https://github.com/kubesphere/console","commit_stats":{"total_commits":3187,"total_committers":105,"mean_commits":30.35238095238095,"dds":0.7900847191716347,"last_synced_commit":"ab34638074fcbde7f7b6dd5943dddc88e9e03072"},"previous_names":[],"tags_count":43,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kubesphere%2Fconsole","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kubesphere%2Fconsole/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kubesphere%2Fconsole/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kubesphere%2Fconsole/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kubesphere","download_url":"https://codeload.github.com/kubesphere/console/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253737460,"owners_count":21956029,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["console","container","dashboard","hacktoberfest","kubernetes","kubesphere"],"created_at":"2024-10-22T14:08:25.697Z","updated_at":"2025-05-14T04:07:39.123Z","avatar_url":"https://github.com/kubesphere.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# KubeSphere Console\n\n[![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/kubesphere/console)\n![](https://github.com/kubesphere/console/workflows/Main/badge.svg)\n[![License: AGPL v3](https://img.shields.io/badge/License-AGPL%20v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)\n\nKubeSphere console is the web interface for [KubeSphere](https://github.com/kubesphere/kubesphere).\n\n![KubeSphere Console](docs/images/dashboard-ui.png)\n\n## Getting Started\n\nConsole should be always used with KubeSphere, you can either use [Kubekey](https://github.com/kubesphere/kubekey) or [ks-installer](https://github.com/kubesphere/ks-installer) to create a KubeSphere cluster.\nThe following will show you how to build console from source code.\n\n### Prerequisite\n\n#### Node.js\n\nConsole is written using Javascript. If you don't have a Node.js development environment, please [set it up](https://nodejs.org/en/download/). The minimum version required is 12.18.\n\n#### Yarn\n\nWe use [Yarn](https://yarnpkg.com/) to do package management. If you don't have yarn, use the following to install:\n\n```\nnpm install -g yarn@1.22.4\n```\n\nThe minimum version required is 1.22.4, but you can use a newer version.\n\n#### [Optional]Docker\n\nThis is optional. If you just want to test and build on your local environment, there is no need to install docker. Otherwise, you need to install it.\n[Install on Mac](https://docs.docker.com/desktop/mac/install/)\n[Install on Windows](https://docs.docker.com/desktop/windows/install/)\n[Install on Ubuntu](https://docs.docker.com/engine/install/ubuntu/)\n\n#### [Optional]Make\n\nThis is optional too, we use `make` to reduce hand work, but it's totally ok without it.\n\n## How to build\n\nClone the repository, and run `yarn \u0026\u0026 yarn build`\n\n```sh\ngit clone https://github.com/kubesphere/console.git\ncd console/\nyarn \u0026\u0026 yarn build\nnpm run serve\n```\n\n\u003e If you have trouble downloading the dependencies, try the following\n\u003e\n\u003e `yarn config set registry https://registry.npmmirror.com`\n\nAfter `npm run serve`, you should see the output like the following\n\n```\n\u003e kubesphere-console@master serve\n\u003e NODE_ENV=production node server/server.js\n\nDashboard app running at port 8000\n```\n\nNow, console is up and running. But since there is no backed KubeSphere cluster, you shouldn't be able to login.\n\n## How to debug\n\nA KubeSphere cluster is required to start debugging. You can refer to [Installation](https://github.com/kubesphere/kubesphere#installation) to create a KubeSphere cluster.\n\nOnce the cluster is up, you replace the address of `ks-apiserver` in `server/config.yaml` with your real address. You can refer to [access KubeSphere apiserver](docs/access-backend.md) to expose your cluster `ks-apiserver`.\n\n```\n  # backend service gateway server\n  apiServer:\n    clientID: kubesphere\n    clientSecret: kubesphere\n    url: http://ks-apiserver\n    wsUrl: ws://ks-apiserver\n```\n\n## How to build container image\n\nJust run the following command with your real `REPO` address.\n\n```\nREPO=yourawesomerepo make container\n```\n\n## How to submit a PR\n\nFollow [Development Workflow](/docs/development-workflow.md) to commit your codes.\n\n## Features Map:\n\n![Features Map](docs/images/module-map.jpg)\n\n## Support, Discussion, and Community\n\nIf you need any help with KubeSphere, please join us at [Slack Channel](https://join.slack.com/t/kubesphere/shared_invite/enQtNTE3MDIxNzUxNzQ0LTZkNTdkYWNiYTVkMTM5ZThhODY1MjAyZmVlYWEwZmQ3ODQ1NmM1MGVkNWEzZTRhNzk0MzM5MmY4NDc3ZWVhMjE).\n\nPlease submit any KubeSphere Console bugs, issues, and feature requests to [KubeSphere Console GitHub Issue](https://github.com/kubesphere/console/issues).\n\n## Contributing to the project\n\nWelcome to contribute to KubeSphere Console, see [Contributing Guide](CONTRIBUTING.md).\n\nThe KubeSphere localization project has been launched on Crowdin. You can help localize the KubeSphere web console by referring to the [localization guide](docs/join-the-kubesphere-localization-project.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkubesphere%2Fconsole","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkubesphere%2Fconsole","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkubesphere%2Fconsole/lists"}