elseware-ui 2.12.4 → 2.12.5
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 +11 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,10 +1,19 @@
|
|
|
1
1
|
# elseware UI
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
## Folder Hierarchy
|
|
4
|
+
- components: Base UI primitives (buttons, inputs, modals, etc.)
|
|
5
|
+
- compositions: Composite reusable structures built from primitives
|
|
6
|
+
- data: Metadata used on the components/compositions
|
|
7
|
+
- layouts: Page layouts that can be used to quickly structure the page formats
|
|
8
|
+
- styles: Tailwind/CSS stylings
|
|
9
|
+
- types: Custom react types
|
|
10
|
+
- utils: Reusable utility functions and hooks
|
|
11
|
+
|
|
12
|
+
## Setup
|
|
4
13
|
|
|
5
14
|
Install the dependendecies via `npm i`.
|
|
6
15
|
|
|
7
|
-
|
|
16
|
+
## Run Storybook
|
|
8
17
|
|
|
9
18
|
To test the components and its features start storybook using `npm run storybook`.
|
|
10
19
|
|