Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dulajkavinda/folio-ui
🦄 A simple, modular and minimalistic component library that gives you the building blocks you need to build your portfolio.
https://github.com/dulajkavinda/folio-ui
nextjs scss storybook typescript ui-library
Last synced: about 1 month ago
JSON representation
🦄 A simple, modular and minimalistic component library that gives you the building blocks you need to build your portfolio.
- Host: GitHub
- URL: https://github.com/dulajkavinda/folio-ui
- Owner: dulajkavinda
- License: mit
- Created: 2022-08-27T16:56:55.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-10-11T14:23:13.000Z (over 1 year ago)
- Last Synced: 2024-12-14T03:04:01.894Z (about 2 months ago)
- Topics: nextjs, scss, storybook, typescript, ui-library
- Language: TypeScript
- Homepage: https://folio-ui.com/docs/quick-start
- Size: 1000 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
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](https://www.folio-ui.com/docs/components/avatar).
## Table of contents
- [Installation](#installation)
- [Usage](#usage)
- [Local Development](#local-development)
- [Contributing](#contributing)
- [License](#license)
## Installation
### Package Managers
```bash
# npm
npm i folio-ui
# yarn
yarn add folio-ui
# pnpm
pnpm i folio-ui
```
## Usage
```js
import { Button } from 'folio-ui'
Hello
```
## 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 `/__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](https://github.com/dulajkavinda/folio-ui/blob/master/CONTRIB)
## License
This project is licensed under the MIT License. You can find more information in the [LICENSE](https://github.com/dulajkavinda/folio-ui/blob/master/LICENSE) file.
#
If you need to reach out to me [contact me](mailto:[email protected]).
