README.md

Eclair UI

Beautiful UI Components for Web at Your Fingertips

Overview

EclairUI is a comprehensive UI component library built with Next.js, React, and TailwindCSS. The project is structured as a Turborepo monorepo, providing a collection of beautiful, customizable components along with development tools and templates.

Repository Structure

.
├── apps/
│   ├── website/      # Main documentation and showcase website
│   ├── template/     # Collection of UI templates
│   └── playground/   # Component testing environment
├── packages/
│   ├── cli/          # EclairUI CLI tool
│   ├── config-eslint/     # Shared ESLint configuration
│   ├── config-tailwind/   # Shared Tailwind configuration
│   ├── config-typescript/ # Shared TypeScript configuration
│   └── ui/           # Core UI components package
└── [configuration files]

Applications

• Website (apps/website): Main documentation and showcase site built with Next.js
• Templates (apps/template): Collection of pre-built UI templates and layouts
• Playground (apps/playground): Development environment for testing components

Packages

• CLI (packages/cli): Command-line interface for EclairUI
• UI (packages/ui): Core UI components library
• Configurations:
  • config-eslint: Shared ESLint rules
  • config-tailwind: Shared Tailwind CSS configuration
  • config-typescript: Shared TypeScript configuration

Getting Started

1. Clone the repository:

git clone https://github.com/GopalVerma1303/EclairUI.git
cd EclairUI

2. Install dependencies:

pnpm install

3. Run the development server:

pnpm dev

Available Scripts

• pnpm dev: Start all applications in development mode
• pnpm build: Build all applications and packages
• pnpm start: Start all applications in production mode
• pnpm lint: Run ESLint across all projects
• pnpm clean: Clean all build outputs and caches

Technology Stack

• Framework: Next.js
• Package Manager: pnpm
• Monorepo Tool: Turborepo
• Styling: Tailwind CSS
• Animation: Framer Motion
• Language: TypeScript
• Linting: ESLint

Development

Prerequisites

• Node.js 16.x or higher
• pnpm 7.x or higher

Local Development

1. Start the development server:

pnpm dev

2. Access the applications:

• Website: http://localhost:3000
• Templates: http://localhost:3001
• Playground: http://localhost:3002

Contributing

We welcome contributions! Please see our Contributing Guide for details on:

• Code of Conduct
• Development process
• How to submit pull requests
• Coding standards

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support

• 📫 Report bugs via GitHub Issues
• 💬 Ask questions in GitHub Discussions
• 📦 Track releases in our Changelog