@soul-refiner/design-system 2.14.62 → 2.14.63

package/README.md

@@ -1,104 +1,109 @@
-# Soul Refiner Design System
-
-A centralized, reusable design system used across all Soul Refiner web applications to maintain visual consistency, streamline development, and speed up feature delivery.
-
-## Package Info
-
-- **Name:** `@soul-refiner/design-system`
-- **Version:** `2.14.17`
-- **License:** MIT
-- **Registry:** [npmjs.org](https://registry.npmjs.org)
-
----
-
-## What’s Included
-
-This design system is built using modern, flexible libraries, making it easy to compose and extend UI components:
-
-### Frameworks & Libraries
-
-| Purpose           | Technology                                                                                                                                                                     |
-| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| Component Library | [React](https://reactjs.org), [Styled-Components](https://styled-components.com), [MUI](https://mui.com), [Radix UI](https://www.radix-ui.com/)                                |
-| Utility Styling   | [TailwindCSS](https://tailwindcss.com), [tailwind-merge](https://github.com/dcastil/tailwind-merge), [tailwindcss-animate](https://github.com/jamiebuilds/tailwindcss-animate) |
-| Rich Text         | [Slate.js](https://docs.slatejs.org/), [Plate Editor](https://plate.udecode.io/)                                                                                               |
-| Media Support     | `react-player`, `react-h5-audio-player`                                                                                                                                        |
-| Tooling & Build   | Rollup, Storybook, Prettier, Husky, Chromatic                                                                                                                                  |
-| Emoji Support     | Emoji Mart                                                                                                                                                                     |
-| Drag-and-Drop     | `react-dnd`, `react-dnd-html5-backend`                                                                                                                                         |
-
----
-
-## Features
-
-- Reusable UI components (inputs, buttons, tooltips, date pickers, etc.)
-- Theme consistency across apps
-- Built with Radix UI and MUI for accessibility and interactivity
-- TypeScript support with full typings
-- Easy integration with apps using `next`, `react`, `styled-components`
-- Visual testing with Storybook and Chromatic
-- Documentation and live examples via Storybook
-
----
-
-## Development Setup
-
-### Install dependencies
-
-```bash
-yarn install
-```
-
-### Build the component library
-
-```bash
-yarn build
-```
-
-### Run Storybook locally
-
-```bash
-yarn storybook
-```
-
-### Format code
-
-```bash
-yarn format
-```
-
----
-
-## Getting Started - Adding the design system to your application
-
-### 1. Install via npm
-
-```bash
-npm install @soul-refiner/design-system
-```
-
-### or using yarn
-
-```bash
-yarn add @soul-refiner/design-system
-```
-
-### To test changes in your design system locally in another app(for example: app-front React/nextjs app) before publishing to NPM or pushing to remote registry
-
-1. **Link the design system package:**
-
-   ```bash
-   cd pkg-design-system
-   yarn link
-   ```
-
-2. **Link the design system in your app:**
-
-   ```bash
-   cd path/to/your/app
-   yarn link @soul-refiner/design-system
-   ```
-
-#### Important to note: Issues with Storybook and Fixes
-
-- [Clickup Doc](https://app.clickup.com/24491279/v/dc/qbd8f-2130/qbd8f-8793)
+# Soul Refiner Design System
+
+A centralized, reusable design system used across all Soul Refiner web applications to maintain visual consistency, streamline development, and speed up feature delivery.
+
+## Package Info
+
+- **Name:** `@soul-refiner/design-system`
+- **Version:** `2.14.17`
+- **License:** MIT
+- **Registry:** [npmjs.org](https://registry.npmjs.org)
+
+---
+
+## What’s Included
+
+This design system is built using modern, flexible libraries, making it easy to compose and extend UI components:
+
+### Frameworks & Libraries
+
+| Purpose           | Technology                                                                                                                                                                     |
+| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| Component Library | [React](https://reactjs.org), [Styled-Components](https://styled-components.com), [MUI](https://mui.com), [Radix UI](https://www.radix-ui.com/)                                |
+| Utility Styling   | [TailwindCSS](https://tailwindcss.com), [tailwind-merge](https://github.com/dcastil/tailwind-merge), [tailwindcss-animate](https://github.com/jamiebuilds/tailwindcss-animate) |
+| Rich Text         | [Slate.js](https://docs.slatejs.org/), [Plate Editor](https://plate.udecode.io/)                                                                                               |
+| Media Support     | `react-player`, `react-h5-audio-player`                                                                                                                                        |
+| Tooling & Build   | Rollup, Storybook, Prettier, Husky, Chromatic                                                                                                                                  |
+| Emoji Support     | Emoji Mart                                                                                                                                                                     |
+| Drag-and-Drop     | `react-dnd`, `react-dnd-html5-backend`                                                                                                                                         |
+
+---
+
+## Features
+
+- Reusable UI components (inputs, buttons, tooltips, date pickers, etc.)
+- Theme consistency across apps
+- Built with Radix UI and MUI for accessibility and interactivity
+- TypeScript support with full typings
+- Easy integration with apps using `next`, `react`, `styled-components`
+- Visual testing with Storybook and Chromatic
+- Documentation and live examples via Storybook
+
+---
+
+## Development Setup
+
+### Requirements
+
+- Node.js 22.x
+- Yarn package manager
+
+### Install dependencies
+
+```bash
+yarn install
+```
+
+### Build the component library
+
+```bash
+yarn build
+```
+
+### Run Storybook locally
+
+```bash
+yarn storybook
+```
+
+### Format code
+
+```bash
+yarn format
+```
+
+---
+
+## Getting Started - Adding the design system to your application
+
+### 1. Install via npm
+
+```bash
+npm install @soul-refiner/design-system
+```
+
+### or using yarn
+
+```bash
+yarn add @soul-refiner/design-system
+```
+
+### To test changes in your design system locally in another app(for example: app-front React/nextjs app) before publishing to NPM or pushing to remote registry
+
+1. **Link the design system package:**
+
+   ```bash
+   cd pkg-design-system
+   yarn link
+   ```
+
+2. **Link the design system in your app:**
+
+   ```bash
+   cd path/to/your/app
+   yarn link @soul-refiner/design-system
+   ```
+
+#### Important to note: Issues with Storybook and Fixes
+
+- [Clickup Doc](https://app.clickup.com/24491279/v/dc/qbd8f-2130/qbd8f-8793)