myob-practice-components
v1.0.0
Published
MYOB Practice specific components. The components that are used in MYOB Practice and are not part of Feelix (yet) or too specific.
Maintainers
Readme
MYOB Practice components library
MYOB Practice specific shared code library
Getting started
npm installnpm startopens Storybook on http://localhost:6006
Commands
npm start-> runs your components in Storybook and watch for changesnpm test-> runs your the components testsnpm run clean-> cleans up the build directoriesnpm run lint-> runs the linter on the Javascript codenpm run format-> runs code style checks on code, styles, json and fix themnpm run type-check-> type checks any Typescript codenpm run build-> produces a production ready artifact containing the componentsnpm run build-storybook-> builds the storybook web pages for deployment / hostingnpm run release-> build and deploy the components as a NPM package
Storybook
Up to date storybook can be found here: https://myob-technology.github.io/myob-practice-components
Regression tests
Pushing to master branch will do the following:
- Build static representation of storybook (build-storybook)
- Upload snapshots of storybook to percy (percy-storybook)
Percy builds can be found here: https://percy.io/MYOB-Spike/myob-practice-components.
Percy build results are also connected to slack channel #myob-practice-components.
Contributing
Refer to our contribution guide
