Introduction

This is a personal UI library for React applications, based on the principles of Atomic Design and styled with Tailwind CSS. The library provides a set of reusable components that can be used to build complex user interfaces.

Features

• Atomic Design: This library follows the principles of Atomic Design, providing atoms, molecules, organisms, templates, and pages as components.
• Tailwind CSS: All components are styled with Tailwind CSS, a utility-first CSS framework for rapidly building custom user interfaces.

Installation

To install this library, run the following command in your terminal:

# npm
npm install xtech-ecp-ui

# yarn
yarn add xtech-ecp-ui

# pnpm
pnpm install xtech-ecp-ui

# bun
bun install xtech-ecp-ui

Usage

Note: Import the styles.css file at the top level of your app. e.g: App.tsx

Here’s an example of how to use a component from this library:

// Import the component you want
import { Button } from 'xtech-ecp-ui';

// Use the component
function SomeComponent() {
  return <Button>Click me</Button>;
}

Documentation

For more detailed information about each component and how to use them, please refer to the documentation.

Contributing

Contributions are welcome! Please read the contributing guide to get started.

License

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