sugUI Design System
This package works together with the sugUI components library.
What can I do with this package?
Most users would fork this repo to create their custom design system based on the sugUI components library. If that's the case, you might want to setup your local environment to have both packages working together with hot reloading.
Local environment setup
First of all, clone this repository in your computer and install the dependencies using
Then clone the sugUI package into your computer. Keep the name of the folder as
sugui. It should look something like this:
Now you need to create a symbolic link to the
Go to the
/sugui folder and type:
Then go to
/sugui-design-system/node_modules folder and type:
yarn link sugui
Done!, now your
sugui folder in
node_modules will reference your cloned
sugui folder, rather than the one downloaded from npm.
Now you can run the styleguide with
yarn run styleguide and it will trigger the Hot Reload every time you change anything in
sugui or in
yarn run styleguide:build
Deploy to Github pages
yarn run deploy