@krrli/cm-designsystem 1.19.7 → 1.19.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +39 -8
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,9 +4,10 @@ A modern React component library built with TypeScript, Tailwind CSS, and Storyb
|
|
|
4
4
|
|
|
5
5
|
## Table of Contents
|
|
6
6
|
|
|
7
|
-
- [
|
|
7
|
+
- [Usage in Your Project](#usage-in-your-project)
|
|
8
8
|
- [Technical Stack](#technical-stack)
|
|
9
9
|
- [Development](#development)
|
|
10
|
+
- [Quick Start Development](#quick-start-development)
|
|
10
11
|
- [Quality Checks](#quality-checks)
|
|
11
12
|
- [Code Style](#code-style)
|
|
12
13
|
- [TypeScript Guidelines](#typescript-guidelines)
|
|
@@ -17,19 +18,35 @@ A modern React component library built with TypeScript, Tailwind CSS, and Storyb
|
|
|
17
18
|
- [Continuous Integration](#continuous-integration)
|
|
18
19
|
- [EditorConfig & VS Code Settings](#editorconfig--vs-code-settings)
|
|
19
20
|
|
|
20
|
-
##
|
|
21
|
+
## Usage in Your Project
|
|
22
|
+
|
|
23
|
+
To use the components and styles in your project:
|
|
24
|
+
|
|
25
|
+
1. Install the package:
|
|
21
26
|
|
|
22
27
|
```bash
|
|
23
|
-
|
|
24
|
-
|
|
28
|
+
npm i @krrli/cm-designsystem
|
|
29
|
+
```
|
|
25
30
|
|
|
26
|
-
|
|
27
|
-
|
|
31
|
+
2. Import the bundled CSS in your app entry (e.g., `main.tsx` or `App.tsx`):
|
|
32
|
+
|
|
33
|
+
```js
|
|
34
|
+
import "cm-designsystem/dist/cm-designsystem.css";
|
|
28
35
|
```
|
|
29
36
|
|
|
30
|
-
|
|
37
|
+
3. Import and use components as needed:
|
|
31
38
|
|
|
32
|
-
|
|
39
|
+
```js
|
|
40
|
+
import { Button } from "cm-designsystem";
|
|
41
|
+
|
|
42
|
+
function App() {
|
|
43
|
+
return (
|
|
44
|
+
<Button label="Click me" intent="primary" size="md" onClick={() => {}} />
|
|
45
|
+
);
|
|
46
|
+
}
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
---
|
|
33
50
|
|
|
34
51
|
## Technical Stack
|
|
35
52
|
|
|
@@ -46,6 +63,20 @@ Storybook will be available at [http://localhost:6006](http://localhost:6006)
|
|
|
46
63
|
|
|
47
64
|
## Development
|
|
48
65
|
|
|
66
|
+
### Quick Start Development
|
|
67
|
+
|
|
68
|
+
```bash
|
|
69
|
+
# Install dependencies
|
|
70
|
+
npm install
|
|
71
|
+
|
|
72
|
+
# Start Storybook development server
|
|
73
|
+
npm run storybook
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
Storybook will be available at [http://localhost:6006](http://localhost:6006)
|
|
77
|
+
|
|
78
|
+
📚 View the deployed Storybook: [https://ost-cas-fea-25-26.github.io/cm-designsystem/](https://ost-cas-fea-25-26.github.io/cm-designsystem/?path=/docs/branding-assets--docs)
|
|
79
|
+
|
|
49
80
|
### Quality Checks
|
|
50
81
|
|
|
51
82
|
Run all quality checks before committing:
|