@gd-uikit/uikit

Design System @jinshuju

preview

https://gd-uikit-next.web.app/

TODO:

• Update dependencies version
• Use ESlint replace TSlint completely
• Use esbuild-loader instead of ts-loader
• Add Unit Tests
• Update Readme

usage:

we recommend to use with babel-import-plugin to auto-load styles

remember to inject the global styles at the very first of your app

import { Utils } from '@gd-uikit/uikit'

const { applyComponentGlobalStyle, applyRebootStyle } = Utils

// in your root component

const RebootStyle = applyRebootStyle()
const ComponentGlobalStyle = applyComponentGlobalStyle()

return (
//...
  <RebootStyle />
  <ComponentGlobalStyle />
//...
)

setup:

• yarn

develop:

• write stories about component using storybook in stories/
• create a new component folder under components/ where the component lives, which you can follow the existing component's file structures.

NOTES:

• prefer default export which can be integrated into the plugin like 'ts-plugin-import' to make bundle in demand works.

build:

• yarn run build

deploy(firebase):

follow the instructions on firebase' hosting doc.

• yarn global add firebase-tools
• yarn run deploy:next

publish:

• yarn publish --tag alpha