https://github.com/kubesphere/kube-design
Kube Design for KubeSphere Console
https://github.com/kubesphere/kube-design
components-library console kubesphere react
Last synced: 6 months ago
JSON representation
Kube Design for KubeSphere Console
- Host: GitHub
- URL: https://github.com/kubesphere/kube-design
- Owner: kubesphere
- License: mit
- Created: 2020-04-03T07:14:06.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-05-28T08:21:01.000Z (over 1 year ago)
- Last Synced: 2024-05-29T01:01:17.519Z (over 1 year ago)
- Topics: components-library, console, kubesphere, react
- Language: JavaScript
- Homepage: https://design.kubesphere.io
- Size: 5.87 MB
- Stars: 101
- Watchers: 8
- Forks: 45
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Kube Design
A suite of components, hooks, and icons. Originally built for KubeSphere Console, but it can also be used for developing any other React web apps.
## Documentation
[https://kubesphere-design.netlify.app/zh](https://kubesphere-design.netlify.app/zh)
## Requirement
Ensure your have the latest version of NodeJS, and a package manager: NPM or Yarn.
- Node.js 12.18+ ([installation with nvm](https://github.com/creationix/nvm#usage))
- Yarn 1.22.4+
## Installation
```sh
$ yarn add @kubed/components @kubed/hooks @kubed/icons
# or
$ npm i @kubed/components @kubed/hooks @kubed/icons
```
## Usage
1. Wrap your application with the `KubedConfigProvider`:
```jsx
import { CssBaseline, KubedConfigProvider } from '@kubed/components';
const Application = () => (
// ---> Normalize styles
// ---> Root of your application
)
```
2. Use components like so:
```jsx
import { Button } from "@kubed/components"
const MyComponent = () => Click Me
```
## Contributing
...
## Thank
We benefit a lot from these awesome project, Many thanks to them.
- [Mantine](https://github.com/mantinedev/mantine)
- [ant-design](https://github.com/ant-design/ant-design/)
- [Geist](https://github.com/geist-org/react)
- [chakra-ui](https://github.com/chakra-ui/chakra-ui/)
## License
MIT © [kubesphere](https://github.com/kubesphere)