Skip to content

Latest commit

 

History

History
39 lines (24 loc) · 1.88 KB

README.md

File metadata and controls

39 lines (24 loc) · 1.88 KB

Float UI logo

Float UI is a collection of modern UI components and website templates built on top of React, and soon, Vue. With Tailwind CSS, the components are beautifully designed and expertly crafted, allowing you to build beautiful websites.

Why Float UI?

Float UI is fully free and open source. You don't need to pay anything to use it, and we are working on it full-time, so we'll keep improving and adding more UIs. If you’re working on a large project that requires a high level of UI customization or you find yourself repeating the same UI patterns across projects, consider creating an internal UI library. In this case, Float UI is a great choice. You should definitely use it.

Prerequisites

Before you begin, ensure you have met the following requirements:

  • You have installed the latest version of npm/yarn/pnpm.
  • You have a Windows/Linux/Mac machine.

Getting Started

First, install the dependencies. We highly recommend using pnpm, and run the development server:

npm run dev
# or
yarn dev
# or
pnpm dev

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

### Quick start

- <strong>[UI components](https://floatui.com/components) :</strong> UI components for React and Vue (soon) with Tailwind, every example support both directions LTR and RTL.

- <strong>[Website templates](https://floatui.com/templates) :</strong> A collection of professional and beautifully designed website templates, built on top of React, Next.js and Nuxt (soon) with Tailwind CSS.

## Contributing

If you're interested in contributing to Float UI, please read our [contributing guide](https://github.com/MarsX-dev/floatui/blob/main/CONTRIBUTING.md) to learn about our development process before submitting a pull request.