Introduction

Ctrl Up Design System is the framework that helps our ecosystem to design and develop consistent and quality experiences. For its Digital section, it is called Rainbow.

This repository hosts a React library for web applications.

Package

This package provides you with a library of React components:

Contributing

The best way to achieve this is together! That's why we are on GitHub. We would love contributions from the community (bug reports, feature requests, suggestions, Pull Requests, whatever you want!).

Npm is used as package manager. Semantic Release is used to manage the whole package release workflow.

To setup your local dev environment:

1. Install Npm

2. Clone repository

git clone [email protected]:ctrlup-io/rainbow-react.git
cd rainbow-react

3. Install dependencies

yarn install

4. See more available scripts

Available Scripts

In the project directory, you can run:

commit

Runs the git-cz CLI to generate commit messages according to the Conventional Commit specifications.

format

Runs Prettier with basic configuration.

We recommend to use Prettier in your IDE, e.g. in Visual Studio code with Prettier - Code formatter.

lint

Runs ESLint.

build

Bundles with Parcel.

It generates report in parcel-bundler-reports folder. To serve it, run :

npx live-server parcel-bundle-reports/module.html

release:dry

Runs Semantic Release in dry-run mode. It allows you to preview the pending release.

You have to set NPM_TOKEN and GITHUB_TOKEN in .env file.

storybook

Runs Storybook on http://localhost:6006/.

Learn how to write stories on official documentation.

storybook:build

Bundles Storybook app with Webpack. See more on Publish Storybook documentation.

test

Runs unit-test suite with Jest and React Testing Library.

To use the full power of the Jest Watcher and LCOV coverage reporter we recommend to use the following scripts concurrently:

• test:watch
• test:coverage