https://github.com/polgubau/pol-ui

Beautiful and reusable React components with ease using our NPM package. Built with Tailwind, React, and TypeScript, these components are fully customizable and ready to be integrated into any reactive website. Save time and effort by using our pre-built components for common UI elements such as buttons, inputs, and more.
https://github.com/polgubau/pol-ui

components library npm pol-ui react reactui ui

Last synced: 8 months ago
JSON representation

Beautiful and reusable React components with ease using our NPM package. Built with Tailwind, React, and TypeScript, these components are fully customizable and ready to be integrated into any reactive website. Save time and effort by using our pre-built components for common UI elements such as buttons, inputs, and more.

• Host: GitHub
• URL: https://github.com/polgubau/pol-ui
• Owner: PolGubau
• License: mit
• Created: 2023-08-12T21:08:10.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-13T15:25:09.000Z (almost 2 years ago)
• Last Synced: 2024-04-13T21:07:14.764Z (almost 2 years ago)
• Topics: components, library, npm, pol-ui, react, reactui, ui
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/pol-ui
• Size: 40.7 MB
• Stars: 5
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

          




  Pol-ui



[![Checked with Biome](https://img.shields.io/badge/Checked_with-Biome-60a5fa?style=flat&logo=biome)](https://biomejs.dev)

[![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)

![GitHub Issues or Pull Requests](https://img.shields.io/github/issues/PolGubau/pol-ui)

![GitHub Issues or Pull Requests](https://img.shields.io/github/issues-pr/PolGubau/pol-ui)

![NPM Version](https://img.shields.io/npm/v/pol-ui)

[![Socket Badge](https://socket.dev/api/badge/npm/package/pol-ui/1.2.0)](https://socket.dev/npm/package/pol-ui/overview/1.2.0)



A complete UI solution for React projects, based on React, TypeScript, and tailwind.

  


  


  Stars are welcome 😊



## 🏎️ Using this package

1. Install the package with npm (or pnpm, bun, pnpm...)

```bash

npm i pol-ui

```

2. Import the components you want to use

```js

import { Button } from 'pol-ui'

```

3. Use them in your project

```jsx

Click me!

```

## 📚 Documentation

- `npm run docs`: Run Storybook documentation in dev mode

- `npm run build:docs`: Build Storybook documentation

## ✅ Testing

This package has unit and component tests configured with Jest

`npm run test`: Run unit tests with Jest and React Testing Library

`npm run test:watch`: Run unit tests on watch mode

## 🔦 Linting

- `npm run lint`: Run linter

- `npm run lint:fix`: Fix lint issues

## 🚀 CI and Publishing

This template comes with a GitHub Actions workflow to automatically publish on any push to `main` when the `package.json` version number differs from the latest on npm.