rolec-ui

The rss-ui library is a ui kit for Rolec applications.

The goal for the repo is to be a single source of truth of web based UI.

Working on this repo

Install the project dependencies with the standard npm i.

Development Builds

It is advised to consume the package in development for testing purposes. This can be achived via npm link or through yalc. For these docs, yalc will be the preferred option but feel free to use any equivalent!

Install

First make sure to install yalc globally. This is used to consume packages in development across repos locally.

npm i yalc -g

Local publish

Run the below in the root of this libraries directory to publish locally.

yalc publish

Consume the package elsewhere

Now that the package is published, we can go into another project repo and run:

yalc add rss-ui

This is particually useful to test changes in a real-world setting without having to republish potentially broken versions of the library for testing.

Storybook

When working on this library, run Storybook to build and document the components.

Storybook will also be used to test the components as they are built. This uses React Testing Library under the hood.

npm run storybook

After successful CI/CD, the Storybook will rebuild and deploy a production version.

Publishing

Any changes submitted through a PR are required to pass a review before automated publishing.

Using the Library

Add the ./node_modules/rss-ui/*/*.tsx to your tailwind.config.js file.