SnowPak UI

React UI Library to be used across SnowPak's NextJS applications. To install, run the following command:

$ npm install --save @snowpak/ui

Development

Storybook has been setup to test the components locally. To start storybook, run the following command:

$ npm run storybook

Build

This project is built via typescript's tsc for both ESM and CJS formats. To build locally for testing purposes, run the following command:

npm run build

Publish

This package is instended to be deployed to npm under the package name @snowpak/ui.

The np library is used to perform the deployment, including:

1. SemVer version bumping
2. Building with pristine dependencies
3. Running tests/linters
4. Releasing to npm
5. Creating a new GitHub release

To deploy, run the following command:

npm run release

Review

Chromatic has been configured to run on Pull Requests and any new commits on the master branch. To view these changes, visit https://www.chromatic.com/builds?appId=5fc72fd4d1a158002151a1ae