@lanun/react-kit

A collection of reusable React UI components built with Vite and Rollup.

Table of Contents

• Installation
• Development
• Generating Components & Sandboxes
• Unit Testing

Installation

To add @lanun/react-kit to your project, install it via npm (or your preferred package manager):

npm install @lanun/react-kit

or

yarn add @lanun/react-kit

or

pnpm add @lanun/react-kit

Development

Before you begin development, make sure you have the following installed:

• Node.js (version 18 or higher)
• pnpm
• pre-commit

Then, clone the repository and install the dependencies:

# clone the repository
git clone https://github.com/syfqpie/lanun
cd lanun

# install pre-commit hook
pre-commit install --hook-type commit-msg

# install dependencies
pnpm install

Running the Development Server

Start the local development server:

pnpm dev

Start the local documentation development server:

pnpm dev:docs

Generating Components

To streamline the creation of new component files, use the provided generate script:

• Create a new component:

  pnpm run generate component <ComponentName>

Unit Testing

Run unit tests using Vitest:

• Watch mode (re-run tests on changes):

  pnpm test

• Single run (without watch mode):

  pnpm test run

Building

To build the component library

pnpm build

To build the documentation

pnpm build:docs