@jars-labs/jars-components 1.0.0 → 1.0.1
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 +65 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,5 +1,9 @@
|
|
|
1
1
|
# jars-components
|
|
2
2
|
|
|
3
|
+
[](https://www.npmjs.com/package/@jars-labs/jars-components)
|
|
4
|
+
|
|
5
|
+
[View on npm](https://www.npmjs.com/package/@jars-labs/jars-components)
|
|
6
|
+
|
|
3
7
|
**jars-components** is a component library designed to standardize and enhance the user interface components used in **Umbrello projects**. This library evolves from the previously used **umbrello-ui** library.
|
|
4
8
|
|
|
5
9
|
## Getting Started
|
|
@@ -19,7 +23,7 @@ Follow these steps to initialize and build the project locally:
|
|
|
19
23
|
```
|
|
20
24
|
2. Install the project dependencies:
|
|
21
25
|
```bash
|
|
22
|
-
|
|
26
|
+
yarn install
|
|
23
27
|
```
|
|
24
28
|
3. Build the project:
|
|
25
29
|
```bash
|
|
@@ -31,11 +35,69 @@ Follow these steps to initialize and build the project locally:
|
|
|
31
35
|
To view the components in a development environment, run the following command:
|
|
32
36
|
|
|
33
37
|
```bash
|
|
34
|
-
|
|
38
|
+
yarn storybook
|
|
35
39
|
```
|
|
36
40
|
|
|
37
41
|
Build the storybook:
|
|
38
42
|
|
|
39
43
|
```bash
|
|
40
|
-
|
|
44
|
+
yarn build-storybook
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
## Publishing a New Version to npm
|
|
48
|
+
|
|
49
|
+
Follow these steps to publish a new version of the **`@jars-labs/jars-components`** package:
|
|
50
|
+
|
|
51
|
+
### 1. Ensure You Are Logged into npm
|
|
52
|
+
|
|
53
|
+
Log in to npm with your credentials:
|
|
54
|
+
|
|
55
|
+
```bash
|
|
56
|
+
npm login
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
Make sure you have the necessary permissions for the jars-labs organization.
|
|
60
|
+
|
|
61
|
+
### 2. Update the Version
|
|
62
|
+
|
|
63
|
+
Use Semantic Versioning:
|
|
64
|
+
|
|
65
|
+
- Patch: For bug fixes or small changes (e.g., 1.0.0 → 1.0.1).
|
|
66
|
+
- Minor: For new features without breaking changes (e.g., 1.0.0 → 1.1.0).
|
|
67
|
+
- Major: For breaking changes (e.g., 1.0.0 → 2.0.0).
|
|
68
|
+
|
|
69
|
+
```bash
|
|
70
|
+
npm version <patch|minor|major>
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
### 3. Build the Package
|
|
74
|
+
|
|
75
|
+
```bash
|
|
76
|
+
yarn build
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
### 4. Verify the Package Content (optional)
|
|
80
|
+
|
|
81
|
+
Test what will be included in the npm package:
|
|
82
|
+
|
|
83
|
+
```bash
|
|
84
|
+
npm pack
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
Extract the contents of the tarball to verify the package content.
|
|
88
|
+
|
|
89
|
+
```bash
|
|
90
|
+
tar -tzf jars-components-<version>.tgz
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
### 5. Publish the Package
|
|
94
|
+
|
|
95
|
+
```bash
|
|
96
|
+
npm publish --access public
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
### 6. Push the tag
|
|
100
|
+
|
|
101
|
+
```bash
|
|
102
|
+
git push --follow-tags
|
|
41
103
|
```
|