August
UIPlus

Installation

Prerequisites

Before installing AugustUI, make sure you have:

  • Node.js 16.8 or later
  • npm, yarn, or pnpm package manager
  • A React project (preferably using Next.js)

Installing AugustUI

You can install AugustUI using your preferred package manager:

Using npm

npm install @augustui/react

Using yarn

yarn add @augustui/react

Using pnpm

pnpm add @augustui/react

Setting up dependencies

AugustUI requires the following peer dependencies:

npm install react react-dom tailwindcss

Configuration

After installation, you need to set up your project configuration:

1. Configure Tailwind CSS

Add the following to your tailwind.config.js:

module.exports = {
  content: [
    './pages/**/*.{js,ts,jsx,tsx}',
    './components/**/*.{js,ts,jsx,tsx}',
    // Add this line to include AugustUI components
    './node_modules/@augustui/react/**/*.{js,ts,jsx,tsx}'
  ],
  // ... rest of your config
}

2. Import styles

Import the AugustUI styles in your main CSS file:

@import '@augustui/react/styles.css';

Next Steps

Now that you have AugustUI installed, you can: