piekit v0.0.13

🥧 piekit

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 piekit to your project, install it via npm (or your preferred package manager):

npm install piekit

or

yarn add piekit

or

pnpm add piekit

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/piekit
cd piekit

# 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 run dev

Generating Components & Sandboxes

To streamline the creation of new components and sandboxes, use the provided generate script:

• Create a new component:

  pnpm run generate component <ComponentName>

• Create a new sandbox:

  pnpm run generate sandbox <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

Documentation

The documentation for piekit can be found in the /docs/README.md file. To view it, simply open the file in the project directory.