https://github.com/paalamugan/paalan-react-shadcn-ui

Reusable react ui components with build on top of Tailwind CSS and Shadcn UI. In this package, We customize the Tailwind CSS and Shadcn UI to make it more user-friendly and easy to use.
https://github.com/paalamugan/paalan-react-shadcn-ui

paalan-react-ui radix-ui react-package recharts shadcn-ui tailwind tailwindcss

Last synced: about 5 hours ago
JSON representation

Reusable react ui components with build on top of Tailwind CSS and Shadcn UI. In this package, We customize the Tailwind CSS and Shadcn UI to make it more user-friendly and easy to use.

• Host: GitHub
• URL: https://github.com/paalamugan/paalan-react-shadcn-ui
• Owner: paalamugan
• Created: 2024-05-18T20:25:41.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-10-21T07:05:09.000Z (29 days ago)
• Last Synced: 2024-11-15T02:22:01.118Z (5 days ago)
• Topics: paalan-react-ui, radix-ui, react-package, recharts, shadcn-ui, tailwind, tailwindcss
• Language: TypeScript
• Homepage:
• Size: 3.35 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Paalan React UI

Reusable react ui components with build on top of Tailwind CSS and Shadcn UI. In this package, We customize the Tailwind CSS and Shadcn UI to make it more user-friendly and easy to use.

## Prerequisites

- If you are using nvm, run `nvm use` to use the correct node version.

- If you are not using nvm, make sure you are using node version `v20.12.2`. You can check your node version by running `node -v`.

## Installation

- Run `pnpm install` to install all the dependencies.

### Build the package

- Run `pnpm build` to build the package.

### Running the storybook for development

- Run `pnpm storybook` to start the storybook app in development mode.

- Open [http://localhost:6006/](http://localhost:6006/) to view it in the browser.

### Running the storybook docs for development

- Run `pnpm storybook:docs` to start the storybook docs in development mode.

- Open [http://localhost:6007/](http://localhost:6007/) to view it in the browser.

### Build the storybook app for production

- Run `pnpm storybook:build` to build the storybook app for production.

### Build the storybook docs for production

- Run `pnpm storybook:build:docs` to build the storybook docs for production.

### Preview the storybook

- Run `pnpm preview` to build the storybook app for production.

### Preview the storybook docs

- Run `pnpm preview:docs` to build the storybook docs for production.

### Generate the code coverage report

- Run `pnpm test:coverage` to generate the code coverage report.

### Running the tests

- Run `pnpm test` to run the tests.

### Running the tests in watch mode

- Run `pnpm test:watch` to run the tests in watch mode.

## Publishing the package to npm through CI/CD pipeline

Once you are ready to publish the package, then run below command in the terminal, it will create a changeset for the package. you have select the package which you want to publish.

```sh

pnpm changeset

```

after the above command, commit the changes and push the changes to the remote repository. So that the CI/CD pipeline will publish the package to npm registry.

### Publishing the package from locally

- First login to npm using `npm login` command(If you are not logged in).

- Run `pnpm changeset` to create a changeset for the package.

- Run `pnpm version` to bump the version of the package.

- Run `pnpm release` to publish the package to npm.

- After that push the changes to the remote repository using this `git push --follow-tags` command.

## Migrate Eslint v8 to v9

- Run `npx @eslint/migrate-config .eslintrc.cjs` to migrate the eslint to v9. for more information [click here](https://eslint.org/docs/latest/use/configure/migration-guide#migrate-your-config-file)