codex-marketplace-ui-compon.../README.md

43 lines
754 B
Markdown
Raw Normal View History

2024-08-20 13:57:58 +00:00
# Codex Marketplace Components
This project provide UI components for Codex Marketplace.
It's in pre-alpha version, the API will change.
## Philosophy
This CSS is written with semantic style. For more details check this [link](https://maintainablecss.com/chapters/semantics).
The components are designed for Codex Marketplace but they can be customized with CSS variables at the global level or at the component level (class or style).
## Prerequisites
- Node 18+
## Install
Run the npm install command:
```
npm install
```
## Run
```
npm run storybook
```
2024-08-20 13:57:59 +00:00
## Build (for deployment)
```
npm run build-storybook
```
The files are generated under the folder storybook-static.
You can preview by using the command:
```
npm run preview
```