convenience-core

Environment

• Node - v18.12.0
• Yarn v1
• VSCode
• Eslint plugin
• Prettier plugin

APIs and Documentation

• Docs

Code base Structure

• src/lib/components: contains all React component that is used by the project
• src/lib/hooks: contains common/shared hooks

• Folder src/lib will be exported

• src/stories: contains all storybook file

• styles/components: contains all css style for components, which be used to parse to cjs file, which will be used to build tailwind plugin

• plugin folder: will be used to build tailwind plugin, for more information, please visit https://tailwindcss.com/docs/plugins

Documents

• Config husky + commintLint
• Degit
• Jenkins vs Github Action
• Networking
• Reference
• Storybook

After completing the development, run:

yarn parse-css to parse _.css to _.cjs file, Then, go to the 'plugin/index.cjs' file, import the component that you've just developed into addComponent section.

Release new version

• Create Merge Request to master branch. The release branch will trigger CI/CD process after change (this action will public package). To release new version, you have to commit with prefix ( fix(pencil): , feat(pencil):, perf(pencil):, ...). More info: https://github.com/semantic-release/semantic-release
• Create Merge Request to release-storybook branch. The release branch will trigger CI/CD process after change (this action will public storybook).