hds-web 1.24.4 → 1.24.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 CHANGED
@@ -1,11 +1,16 @@
1
- HASURA DESIGN SYSTEM
2
-
3
- node version:18.12.1
1
+ # Hasura Design System
2
+ ## **Integrate the hds-web in your project**
3
+ <br>
4
4
 
5
+ Node version: 18.12.1
6
+
7
+ ### Steps:
5
8
  Step 1: npm install hds-web
6
9
 
7
10
  Step2: In tailwind.config.js file have the following preset:
8
11
 
12
+
13
+
9
14
  module.exports = {
10
15
  presets: [
11
16
  require('hds-web/tailwind.config.js'),
@@ -19,4 +24,59 @@ Step2: In tailwind.config.js file have the following preset:
19
24
 
20
25
 
21
26
  Step3: In you main css file:
27
+
22
28
  @import 'hds-web/dist/index.css';
29
+
30
+ </br>
31
+
32
+
33
+ ## Storybook local setup:
34
+ <br>
35
+ Check node version 18.16.2 and run
36
+
37
+ npm install
38
+
39
+ npm run storybook
40
+
41
+ open localhost:6006
42
+
43
+ </br>
44
+
45
+ ## Contribution:
46
+ <br>
47
+
48
+ - Pull the latest storyboook changes
49
+ - Add your component in the library - `/src/HDS/components` and add the component story - `/src/stories` .
50
+ - Build library ( locally or pipeline )
51
+ - Publish package
52
+
53
+ </br>
54
+
55
+ ## Chromatic release
56
+ <br>
57
+ Pull the latest changes from main branch in your branch
58
+ Merge your branch to release-chromatic
59
+ </br>
60
+
61
+ ## Publish
62
+
63
+ <br>
64
+ The package can be published locally or via the pipeline.
65
+
66
+ ### For Local:
67
+
68
+ >Note: The user must be registered as **Hasura**
69
+
70
+ #### Run the below set of commands:
71
+
72
+ npm run build-lib
73
+
74
+ ### Note before publishing:
75
+ >Make sure the build is successful with no error<br>
76
+ All the components should be exported properly,<br>
77
+ The branch is updated with the latest changes in main branch <br>
78
+ The package version is upgraded before publishing<br>
79
+
80
+ npm publish
81
+
82
+ </br>