🚀 NovaUI

A modern, lightweight CLI tool for initializing UI component libraries with essential dependencies and project structure.

✨ Features

• 🏗️ Quick Setup - Initialize your UI project structure in seconds
• 📦 Smart Dependencies - Automatically installs essential packages like clsx and tailwind-merge
• 🎨 Beautiful Output - Gradient-styled CLI with clear progress indicators
• 🔧 Zero Configuration - Works out of the box with sensible defaults
• ⚡ TypeScript Ready - Built with TypeScript for better developer experience

📋 What NovaUI Creates

When you run novaui init, it will:

• Create essential directories: lib/, components/, src/
• Install core dependencies: clsx, tailwind-merge
• Set up your project structure for component development
• Provide a local registry URL for component management

🚀 Quick Start

Installation

npm install -g @nill/novaui

Usage

Navigate to your project directory and run:

novaui init

That's it! Your project structure will be created and dependencies installed automatically.

📁 Project Structure

After running novaui init, your project will have:

your-project/
├── lib/           # Utility functions and shared logic
├── components/    # Your UI components
├── src/           # Source files
└── node_modules/  # Dependencies (clsx, tailwind-merge)

🛠️ Built With

• TypeScript - Type-safe development
• Node.js - Runtime environment
• chalk - Terminal styling
• gradient-string - Beautiful gradient text
• tsup - Fast TypeScript bundler

📦 Dependencies Installed

NovaUI automatically installs these essential packages:

• clsx - Utility for constructing className strings conditionally
• tailwind-merge - Merge Tailwind CSS classes without style conflicts

🎯 Perfect For

• React component libraries
• Next.js projects
• TypeScript UI projects
• Tailwind CSS workflows
• Design system development

🔧 Requirements

• Node.js 18 or higher
• npm or yarn package manager

📖 Commands

Currently, NovaUI supports one main command:

novaui init

Initializes a new NovaUI project structure with:

• Essential directories
• Core dependencies
• Development setup

🌐 Registry

NovaUI sets up a local component registry at:

https://noova-ui.vercel.app/registry

Use this for managing and sharing your components across projects.

🤝 Contributing

We welcome contributions! Here's how you can help:

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

📝 License

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

🎉 What's Next?

After running novaui init, you can:

1. Start building your components in the components/ directory
2. Add utility functions to the lib/ directory
3. Organize your source files in the src/ directory
4. Leverage clsx and tailwind-merge for styling

💡 Pro Tips

• Use clsx to conditionally apply CSS classes
• Combine tailwind-merge with clsx for conflict-free styling
• Organize components by feature in subdirectories
• Keep utility functions pure and well-tested

Built by @nill with ❤️

Report Bug · Request Feature · Documentation