@commerce7/admin-ui 1.10.46 → 1.10.47

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.
Files changed (2) hide show
  1. package/README.md +58 -0
  2. package/package.json +3 -3
package/README.md CHANGED
@@ -68,3 +68,61 @@ function SaveButton() {
68
68
  return <Button>Hello World</Button>;
69
69
  }
70
70
  ```
71
+
72
+ <br />
73
+
74
+ ## Linking and Unlinking for Local Packages
75
+
76
+ At times in may be required to link a project to admin-ui locally for development testing purposes. To do this have 2 terminals open. One terminal should be in the root of your local folder of the admin ui package and the other should be in the root to the project you would like to use the local package in. VS code should also be open.
77
+
78
+ Examples used here are admin and admin-ui.
79
+
80
+ ### Linking
81
+
82
+ ```
83
+ In admin-ui terminal
84
+ 1. npm build
85
+ 2. npm link
86
+ ```
87
+
88
+ ```
89
+ In admin terminal
90
+ 3. npm install
91
+ ```
92
+
93
+ ```
94
+ In VS code -> admin repo
95
+ 4. Go to node modules, @commerce7, admin-ui and delete this folder
96
+ ```
97
+
98
+ ```
99
+ In admin terminal
100
+ 5. npm link @commerce7/admin-ui
101
+ ```
102
+
103
+ ```
104
+ In VS code
105
+ 6. Restart VS code
106
+ ```
107
+
108
+ After rebooting VS code the @commerce7 admin-ui folder should have an arrow icon beside it. This shows it is properly linked.
109
+
110
+ ### Unlinking
111
+
112
+ ```
113
+ In admin terminal
114
+ 1. npm unlink
115
+ ```
116
+
117
+ ```
118
+ In admin terminal
119
+ 2. npm unlink
120
+ ```
121
+
122
+ ```
123
+ In VS code in admin project
124
+ 1. Delete @commerce7 admin ui
125
+ 2. Restart vs code
126
+ ```
127
+
128
+ After restarting the arrow icon should be removed. This means the project has successfully be unlinked from the local version of admin ui.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@commerce7/admin-ui",
3
- "version": "1.10.46",
3
+ "version": "1.10.47",
4
4
  "description": "Commerce7 Admin UI Component Library",
5
5
  "keywords": [
6
6
  "Commerce7"
@@ -22,7 +22,7 @@
22
22
  },
23
23
  "devDependencies": {
24
24
  "@actions/core": "^1.9.1",
25
- "@actions/github": "^5.0.0",
25
+ "@actions/github": "^5.1.0",
26
26
  "@babel/core": "^7.19.1",
27
27
  "@babel/eslint-parser": "^7.19.1",
28
28
  "@babel/plugin-proposal-class-properties": "^7.18.6",
@@ -42,7 +42,7 @@
42
42
  "@storybook/theming": "^6.5.12",
43
43
  "babel-loader": "^8.2.5",
44
44
  "css-loader": "^6.7.1",
45
- "eslint": "^8.23.1",
45
+ "eslint": "^8.24.0",
46
46
  "eslint-config-airbnb": "^19.0.4",
47
47
  "eslint-config-prettier": "^8.5.0",
48
48
  "eslint-import-resolver-webpack": "^0.13.2",