A shared library used within the eco-system of Walcron. All components can be reused and running examples can be referred in storybook. Components are fully tested but maybe restricted.
Clone the codes and refer examples by running storybook.
Firstly clone from the repository and download the necessary dependencies.
npm install
To execute the program for development
npm run dev
To execute the program for storybook
npm run storybook
To run tests
npm run test
NOTE: Remember to expose all files into index.ts and add into integration test before publishing.
- Update versioning 'patch'|'minor'|'major'. Please bump before opening Pull Request.
npm version <release>
- To build and publish, this is built into Gitlab CI/CD integration with allow/continue on failure.
npm publish
-
For auto publishing, please allow Profile -> Settings -> Personal Access Token (classic), open read:packages, write:packages, delete:packages. For more info refer: https://docs.github.com/en/packages/working-with-a-github-packages-registry
-
Login with
npm login --scope=@yoonghan --auth-type=legacy --registry=https://npm.pkg.github.com/
- Files are exported in main index.ts for components, utils. Please add check into integration.test.tsx.
- Components are imported via import { Accordion } from "@yoonghan/walcron-microfrontend-shared".
- Css files are required to be imported seperately, @yoonghan/walcron-microfrontend-shared/dist/style.css.