@leapdev/gui 1.0.87 → 1.0.88

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
@@ -4,12 +4,67 @@
4
4
 
5
5
  This is source scss of LEAP GUI Toolkit.
6
6
 
7
- ## Quick Start
7
+ ## Developement workflow
8
8
 
9
- 1. Install [Node.js & NPM](https://nodejs.org/en/download/)
10
- 2. Install Project Dependencies `yarn install`
11
- 3. Run `npm link` in Terminal to symlink the project folder. For more Info, visit [npm-link](https://docs.npmjs.com/cli/link)
12
- 4. Run `yarn run build` in Terminal to compile GUI
9
+ ### Auto-updates
10
+
11
+ #### In GUI project
12
+
13
+ 1. Make sure you have the latest Node installed [Node.js](https://nodejs.org/en/download/)
14
+
15
+ 2. Install dependencies
16
+ Corepack and yarn 4 is recommended.
17
+
18
+ ``` Bash
19
+ corepack enable
20
+ yarn
21
+ ```
22
+
23
+ 3. Run serve
24
+ ``` Bash
25
+ yarn serve
26
+ ```
27
+ `serve` script auto-publishes once, then pushes updates everytime changes made to SCSS.
28
+
29
+
30
+ #### In the consumed project (eg. Sirius), link GUI package and start dev server
31
+ ``` Bash
32
+ npx yalc link @leapdev/gui # or yalc link @leapdev/gui if you have installed yalc locally
33
+ yarn start leap test.au
34
+ ```
35
+
36
+ Remember to add `.yalc` and `yalc.lock` to gitignore if you haven't done already.
37
+
38
+ Now make changes to SCSS → auto-updates in Sirius!
39
+
40
+
41
+ ### Manual updates
42
+
43
+ Install dependencies as usual.
44
+
45
+ #### In GUI
46
+ 1. Publish package, one time only
47
+ ```Bash
48
+ yarn local:publish
49
+ ```
50
+
51
+ 2. Build and push changes manually
52
+ ```Bash
53
+ yarn build:push
54
+ ```
55
+ #### In the consumed project (e.g. Sirius)
56
+ Link the package and start dev server same as the auto-update workflow
57
+ ``` Bash
58
+ npx yalc link @leapdev/gui
59
+ yarn start leap test.au
60
+ ```
61
+
62
+
63
+ ## Build for Production
64
+
65
+ 1. Make sure you have the latest Node installed [Node.js](https://nodejs.org/en/download/)
66
+ 2. Install project dependencies `yarn`
67
+ 3. Run `yarn build` in Terminal to compile GUI
13
68
 
14
69
  ## Notes
15
70
  1. Currently using an 1.32.13 (older version) until SASS devs apply a patch for deprecation warnings regarding division. Issue discussed here https://github.com/sass/libsass/issues/2822#issuecomment-482914373