https://github.com/raid-guild/design-system
A Chakra-based component library with drop-in theming
https://github.com/raid-guild/design-system
Last synced: 8 months ago
JSON representation
A Chakra-based component library with drop-in theming
- Host: GitHub
- URL: https://github.com/raid-guild/design-system
- Owner: raid-guild
- License: mit
- Created: 2021-09-07T20:18:09.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2025-05-29T20:55:45.000Z (about 1 year ago)
- Last Synced: 2025-10-13T09:35:07.826Z (8 months ago)
- Language: TypeScript
- Homepage: https://raid-guild.github.io/design-system/
- Size: 22.8 MB
- Stars: 11
- Watchers: 6
- Forks: 3
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Raid Guild Design System User Guide
## Usage
1. `npm -i @raidguild/design-system`
2. `import { RGThemeProvider } from @raidguild/design-system`
3. wrap `` in ` `
4. in rest of app for instance use `import { Button } from @raidguild/design-system`
We recommend using the `RGThemeProvider` which automatically provides the Raid Guild theme as well. In case you prefer finer control over the styling, `ChakraProvider` and `theme` are also available via this package.
# Contributing to the Raid Guild Design System
## Running the Storybook to see components and theme in the browser
1. fork and clone the repo
2. `yarn install`
3. `yarn build-storybook`
4. `yarn storybook`
On http://localhost:6006/ you'll see the components built in the [storybook](https://storybook.js.org/).
## Prettier
If you do not already use [Prettier](https://prettier.io/), please add Prettier to your text editor. Prettier allows us to have consistent formatting without having to think much about it.