folio-ui
v2.3.3
Published
<div align="center"> <a width="100%" href="https://www.dulaj.dev" target="_blank"> <img src="https://d3w2fcjgwwg2qu.cloudfront.net/cover-folio.png"/> </a> <p>FolioUI is a simple, modular and minimalistic component library that gives you the buil
Downloads
28
Readme
Checkout the documentation here › folio-ui.com.
Table of contents
Installation
Package Managers
# npm
npm i folio-ui
# yarn
yarn add folio-ui
# pnpm
pnpm i folio-ui
Usage
import { Button } from 'folio-ui'
<Button>Hello</Button>
Local Development
The main
branch contains the latest version of the CommandK component.
To begin local development:
yarn install
yarn run storybook
Storybook will appear on on http://localhost:6006
You can run yarn test
to execute the test suite and linters. To help you develop the component we’ve set up some tests that cover the basic functionality (can be found in <component>/__tests__
).
To check the test coverage you can run yarn coverage
.
Contributing
Contributions are welcome! If you have any ideas, bug reports, or feature requests, please submit them through the GitHub issue tracker. If you would like to contribute code, follow these steps:
- Fork the repository.
- Create a new branch for your feature or bug fix.
- Make the necessary changes and commit them.
- Push your changes to your forked repository.
- Submit a pull request to the main repository.
Find the contribution guideline here CONTRIB
License
This project is licensed under the MIT License. You can find more information in the LICENSE file.
If you need to reach out to me contact me.