Skip to content

AmeyaUpalanchi/unclub-react-ui

Repository files navigation

Unclub React UI

Quickly build beautiful React apps. Unclub React-UI is a animated UI components library for developing fast and gorgeous interfaces in React.

license semantic-release release workflow npm downloads codecov Commitizen friendly

🔥 Installation

Unclub React UI is available as an npm package 📦🚀

// with npm
npm install @unclub/react-ui

// with yarn
yarn add @unclub/react-ui

🚀 Usage

Here is a quick example to get you started, it's all you need:

import * as React from 'react';
import ReactDOM from 'react-dom';
import { Button } from '@unclub/react-ui';

function App() {
  return <Button size="large" rounded={true}>Hello World</Button>;
}

ReactDOM.render(<App />, document.querySelector('#app'));

Yes, it's really all you need to get started as you can see in this live and interactive demo:

Edit Button

🥉 Examples

Are you looking for an example project to get started? We host some.

👨‍💻 Documentation

Check out our documentation website.

🔌 Contributing

Read the contributing guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Unclub React UI.

📄 Changelog

If you have recently updated, please read the changelog for details of what has changed.

🛣️ Roadmap

The future plans and high priority features and enhancements can be found in the roadmap file.

🤟 License

This project is licensed under the terms of the MIT license.