components-ui

components-ui copied to clipboard

Component library based on Vue and Tailwind

Documentation

For full documentation, visit Documentation.

Libraries

The following libraries are being used in this project.

• Vue input mask

Bumb version

Given a version number MAJOR.MINOR.PATCH, increment the:

• MAJOR: a commit that has the text BREAKING CHANGE: section introduces a breaking API change. A breaking change can be part of commits of any type. e.g., a fix:, feat: & chore: types would all be valid, in addition to any other type.
• MINOR: a commit of the type feat introduces a new feature to the codebase
• PATCH: a commit of the type fix patches a bug in your codebase

Quick start

1 Install npm

npm install @solfacil/components-ui

or yarn

yarn add @solfacil/components-ui

2 Run storybook

yarn run storybook

Available commands

$ start # Run the development environment
$ build # Generates the production build
$ lint # Perform eslint to check code error patterns
$ generate {NameComponent} # Generates the base files of a components
$ proxy # Generate a proxy with ngrok

License

Released under the MIT License. Copyright (c) Solfácil.