@anyuzer/starter-ux-lib
v0.0.7
Published
A UX component library scaffold, ready for multi-tenant applications
Downloads
11
Readme
starter-ux-components
This is my basic structure for a reusable component library for multi-tenant react apps. It's intended to be published as an npm package (likely private), and installed in your front end applications.
Manage your themes, and component logic in your ux-library, then build and upgrade front end applications safely.
Comes out of the box with convenient methodology for building mobile first, highly performance responsive sites. Example theme, with example components is configured and used in starter-ux
repo.
Basic usage
- Install requirements for local development:
npm install
- Run storybook to test components:
npm run storybook
- Build compiled components:
npm run build
- Build AND publish a patch (0.0.+1) to npm:
npm run publishPatch
Basic Structure
- /.storybook (storybook config)
- /dist (compiled minified components)
- /src
- /themes (theme configuration)
- /utils (convenience functions for writing themed styles)
- /UX (individual React components)
Storybook
Notes
- The script
npm run publishPatch
will not work if you manually build and commit the build first. This is because the build won't produce any changes, and then the git commit identifies there is nothing to commit and exits (breaking the command chain).