Getting Started

To use FRUI in your project, run one of the following commands in your terminal:

$ npm install frui
Copy

Peer Dependencies

Please note that react and react-dom are peer dependencies, meaning you should ensure they are installed before installing FRUI.

{
  "peerDependencies": {
    "react": "^18.0.0",
    "react-dom": "^18.0.0"
  }
}
Copy

Add FRUI to Your CSS

Add FRUI to your css file by importing the following line:

@import url('frui/frui.css')
Copy

Icons

You can use any icon library you like, but a lot of the examples in this documentation uses Font Awesome. You can add it to your css by importing the following line:

@import url("https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.2.0/css/all.min.css")
Copy

Style Engine

You can use any style engine you like (or none at all), but a lot of the examples in this documentation uses Tailwind CSS.