Vyriy Preset - Library

Reusable React component library for library applications.

This repository is a Yarn workspace with shared package tooling, Storybook documentation, and Jest tests.

Create this example

npm create vyriy@latest

Choose the library preset.

Packages

@library/components

React components exported from packages/components.

import { Button } from '@library/components';

The package currently includes:

ComponentDescription
ButtonStyled HTML button with primary and secondary variants.

Development

Install dependencies:

yarn install

Run Storybook:

yarn storybook

Run the full validation suite:

yarn check

Focused commands are also available:

yarn lint
yarn build
yarn test

Documentation

Storybook renders the package documentation from the repository README files:

  • README.md for the library overview.
  • packages/components/README.md for the components package.
  • packages/components/button/README.md for Button usage and props.

Project Guidance

These articles describe the development approach behind this preset and provide practical guidance for evolving a project on top of it: