@choosemycompany/ui 0.0.10 → 0.1.0
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 +4 -30
- package/dist/assets/index.css +1 -1
- package/dist/index.umd.js +1 -1
- package/package.json +2 -1
package/README.md
CHANGED
|
@@ -14,23 +14,10 @@ design system. ChooseMyCompany UI is written in [Vue.js](https://vuejs.org) and
|
|
|
14
14
|
pnpm add @choosemycompany/ui
|
|
15
15
|
```
|
|
16
16
|
|
|
17
|
-
> **Note:** Make sure to also install ChooseMyCompany UI's peer dependencies. Refer to the
|
|
18
|
-
> [`package.json`](./package.json) for the list of peer dependencies and their expected versions.
|
|
19
|
-
|
|
20
|
-
1. In your main entrypoint **before** importing or using any component:
|
|
21
|
-
|
|
22
|
-
```javascript
|
|
23
|
-
import setConfigs from "@choosemycompany/ui/dist/config";
|
|
24
|
-
|
|
25
|
-
setConfigs();
|
|
26
|
-
```
|
|
27
|
-
|
|
28
|
-
This will set the global configs used by ChooseMyCompany UI.
|
|
29
|
-
|
|
30
17
|
1. Include the required stylesheets in your app.
|
|
31
18
|
|
|
32
19
|
```css
|
|
33
|
-
@import "@choosemycompany/ui/dist/index.css";
|
|
20
|
+
@import "@choosemycompany/ui/dist/assets/index.css";
|
|
34
21
|
```
|
|
35
22
|
|
|
36
23
|
1. Import the components as desired:
|
|
@@ -44,7 +31,7 @@ design system. ChooseMyCompany UI is written in [Vue.js](https://vuejs.org) and
|
|
|
44
31
|
|
|
45
32
|
## Quick start - development
|
|
46
33
|
|
|
47
|
-
Make sure you have [Node](https://nodejs.org/en/)
|
|
34
|
+
Make sure you have [Node](https://nodejs.org/en/) 23.x (LTS) and [pnpm](https://pnpm.io/) 10.12 or newer.
|
|
48
35
|
|
|
49
36
|
```sh
|
|
50
37
|
# Clone the project
|
|
@@ -57,23 +44,10 @@ cd cmc-ui
|
|
|
57
44
|
pnpm install
|
|
58
45
|
|
|
59
46
|
# Build and launch storybook to see the components in the browser
|
|
60
|
-
pnpm storybook
|
|
47
|
+
pnpm storybook:run
|
|
61
48
|
```
|
|
62
49
|
|
|
63
|
-
Go to <http://localhost:
|
|
64
|
-
|
|
65
|
-
## Testing
|
|
66
|
-
|
|
67
|
-
### Unit tests
|
|
68
|
-
|
|
69
|
-
Components’ unit tests live in the `tests/components`. The tests are organized following the same
|
|
70
|
-
directory structure used to organize components.
|
|
71
|
-
|
|
72
|
-
- `pnpm test:unit` runs all unit tests.
|
|
73
|
-
|
|
74
|
-
- `pnpm test:unit:watch` runs all unit tests in watch mode.
|
|
75
|
-
|
|
76
|
-
- `pnpm test:unit:debug` runs all unit tests and allow to attach a debugger to the test runner process.
|
|
50
|
+
Go to <http://localhost:6006/>
|
|
77
51
|
|
|
78
52
|
### Design tokens
|
|
79
53
|
|