Getting Started

Get started building modern applications with Aviris UI.

Installation

Install Aviris UI and its peer dependencies using your preferred package manager:

pnpm add @aviris/ui

Setup

Add the following to your tailwind.config.js:

/** @type {import('tailwindcss').Config} */
module.exports = {
  content: [
    // ... your content paths
    "./node_modules/@aviris/ui/dist/**/*.{js,ts,jsx,tsx}",
  ],
  plugins: [
    require("tailwindcss-animate"),
  ],
}

Add the following to your global CSS file:

@import "@aviris/ui/globals.css";

Usage

Import components from @aviris/ui and start building your application:

import { Button } from "@aviris/ui/components/ui/button"

export default function Page() {
  return (
    <Button>Click me</Button>
  )
}

Next Steps