woodreamz-components-library v0.0.6

Getting Started

This is a template for components library. Built with vite (library mode), swc, vitest, eslint (airbnb style), typescript and storybook.

1. Requirements

   1. Node >= 16.14

2. Install pnpm (installation page)

npm install -g pnpm

3. Install dependencies:

pnpm install

4. Storybook

Use storybook to develop your components.

pnpm dev

5. Sandbox

You can run the sandbox to test your build.

pnpm sandbox

6. Unit Tests

Each component in the library defines its own unit tests.

The tests may be ran with the following command:

pnpm test

7. Build

pnpm build

8. Publish

To publish the package:

pnpm build && pnpm publish ./dist