kyrim-ui v0.7.1

kyrim-ui

Collection of Kyrim's user interface components.

Prerequisites

• Node.js
• yarn
• Git
• Visual Studio Code
• TailwindCSS Intellisense
• TypeScript

Setup

Setup the repository to run development server locally at localhost:6006

git clone https://git.infra.pvg.im/kyrim-front-end/kyrim-ui.git
cd kyrim-ui
yarn install
yarn run storybook

Build Library

Make sure you have been setup the repository and then run the build script using

yarn run build

It will generate and bundle all component to both ESM and UMD (as fallback)

Publish Library

Run below command to automatically build library, bump version and tag, generate changelog, and publish kyrim-ui to npm registry

yarn run release

Build Storybook For Deployment

Storybook brings together UI, examples, and documentation in one place. That helps the team adopt existing UI patterns. To deploy it run

yarn run build-storybook

Libraries & Tools

Here some libraries and tools to make our live easier

• Radix UI
• Tailwind CSS
• Storybook
• CVA
• Semantic Release on Local
• np
• auto-changelog

FAQ

It's make development faster and easier, since the headless component already have the functionality and then it's up to us to style the component to match the design that designer provided.

See https://storybook.js.org/docs/react/writing-docs/mdx

See: https://kyrim-ui.vercel.app/