FolioUI is a simple, modular and minimalistic component library that gives you the building blocks you need to build your portfolio.

Checkout the documentation here › folio-ui.com.

Table of contents

• Installation
• Usage
• Local Development
• Contributing
• License

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:

1. yarn install
2. 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:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make the necessary changes and commit them.
4. Push your changes to your forked repository.
5. 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.