mirror of
https://github.com/hazemKrimi/crimson-quirks-ui.git
synced 2026-05-02 02:30:29 +00:00
30 lines
688 B
Markdown
30 lines
688 B
Markdown
# Crimson Quirks UI
|
|
|
|
A UI component library utilizing Vite and Storybook to be used in my personal projects.
|
|
|
|
## Requirements
|
|
|
|
You need to have `react` and `styled-components` already installed as they are peer dependencies.
|
|
|
|
## Installation
|
|
|
|
To install the package using `yarn` run the following command:
|
|
|
|
```
|
|
yarn add crimson-quirks-ui
|
|
```
|
|
|
|
You can use any other package manager you prefer like `npm`.
|
|
|
|
## Development
|
|
|
|
If you want to add more components for example and you want a development environment you can use `storybook`:
|
|
|
|
```
|
|
yarn storybook
|
|
```
|
|
|
|
## Reference
|
|
|
|
I used this [Starter Component Library Repo](https://github.com/dev-divein/react-storybook-tailwind) as a reference.
|