name: 1.Read me route: /
@q-free/ui
Q-free UI library.
Built with
- React (16.x)
- Typescript (3.x)
- Tailwind CSS - (1.x) A utility-first CSS framework for rapidly building custom designs.
- Webpack (4.x)
- Babel (7.x)
- Code quality (linting) for Typescript.
Installation
- Clone/download repo from ''
yarn
Usage
Build
yarn build
- Build app once (HMR disabled) to
/dist/
Publish
Build
yarn publish
- Publish
/dist/to npm as a package
All commands
| Command | Description |
|---|---|
yarn build |
Build app to /dist/
|
yarn tailwind:css |
Build Css from tailwind css config |
yarn documentation |
Builds documentation and docs.api to /docs/
|
yarn lint |
Run Typescript linter |
yarn lint --fix |
Run Typescript linter and fix issues |
Note: replace yarn with npm in package.json if you use npm.