Skip to content

metisjs/metis-ui

Repository files navigation

Metis UI

NPM version NPM downloads

A React component library styled with Tailwind CSS, inspired by Ant Design.

✨ Features

  • Reusable Component Logic: Built on Ant Design's logic to ensure consistent interaction patterns.
  • Flexible Styling: Fully customizable styles powered by Tailwind CSS, with the ability to quickly override default styles.
  • Modern Tech Stack: Built with React, Tailwind CSS, and TypeScript support.
  • Documentation-Driven Development: Quickly develop and debug components with example-driven documentation.

📦 Installation

Install via npm or pnpm:

# Using npm npm install metis-ui # Using pnpm pnpm add metis-ui

🔨 Usage

Import and use components in your project:

import React from 'react'; import { Button } from 'metis-ui'; const App = () => ( <div> <Button type="primary">Click Me</Button> </div> ); export default App;

📚 Documentation

Visit the official documentation for a complete guide and examples.

🛠️ Local Development

Clone the repository and install dependencies:

# Clone the repository git clone https://github.com/your-repo/metis-ui.git cd metis-ui # Install dependencies pnpm install # Start the development environment pnpm start

Build the project:

# Build the component library pnpm run build # Build the documentation pnpm run docs:build

🤝 Contributing

We welcome contributions! Please read the Contributing Guide to learn how to get involved.

📄 License

MIT