https://github.com/arkemishub/ui

UI components library based on tailwindcss
https://github.com/arkemishub/ui

arke tailwindcss ui

Last synced: 25 days ago
JSON representation

UI components library based on tailwindcss

• Host: GitHub
• URL: https://github.com/arkemishub/ui
• Owner: arkemishub
• License: apache-2.0
• Created: 2023-05-12T12:23:23.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-11-11T16:02:01.000Z (2 months ago)
• Last Synced: 2024-12-01T14:39:22.429Z (about 1 month ago)
• Topics: arke, tailwindcss, ui
• Language: TypeScript
• Homepage:
• Size: 2.45 MB
• Stars: 16
• Watchers: 2
• Forks: 1
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# @arkejs/ui

![UI](https://github.com/arkemishub/ui/assets/81776297/29f37eaf-cd2a-40c5-b4ea-e236cdcffc4c)

[![codecov](https://codecov.io/gh/arkemishub/ui/branch/main/graph/badge.svg?token=RXV4ARVWHO)](https://codecov.io/gh/arkemishub/ui)

![Build Status](https://img.shields.io/github/actions/workflow/status/arkemishub/ui/release.yml)

[![npm latest package](https://img.shields.io/npm/v/@arkejs/ui/latest.svg)](https://www.npmjs.com/package/@arkejs/ui)

[![License](https://img.shields.io/badge/license-Apache2.0-blue.svg)](https://github.com/arkemishub/arke-monorepo/blob/master/LICENSE.txt)

### Getting started

Install the package by running:

```shell

pnpm i @arkejs/ui

```

Extend your `tailwind.config.js` with

```js

module.exports = {

    content: [

        // ... others

        './node_modules/@arkejs/ui/dist/**/*.{js,ts,jsx,tsx}',

    ],

    plugins: [require("@arkejs/ui/plugin")],

}

```

### How versioning with changesets

The @arkejs/ui use [changeset](https://github.com/changesets/changesets) to versioning changes.

After your commits run `npx changeset`, it will ask if you want to use a patch/minor/major a summary for your changes.

Completed the process will be created a `.md` file under `.changeset` folder, commit it to create your PR.