Raven Design System UI

RDS, Carleton University’s design system, is a living digital organism uniting campus wide teams around a common visual language.

Requirements

• NodeJS
• Node Version Manager
• Yarn

On First Setup

Clone this repo

git clone git@github.com:cuweb/rds-ui.git

Check your nvm version

nvm i

Set project's npm version

nvm use

Install project

yarn install

After Setup

One you have completed the initial setup above, moving forward to start the development environent you simply need to go to the project directory and run

nvm use && yarn dev

Test

Start component and e2e tests

yarn test

Run headless / ci tests

yarn test:ci

Release

This project auto-publishes NPM releases. Please run the pre-release commeand before publish your new release

yarn prerelease

Features

• Storybook
• NextJS
• Cypress
• Adobe React Aria
• AirBnb ESLint/Prettier suppoer

CLI Commands

Lists all posible CLI commands

yarn run --non-interactive

Troubleshoting

Storybook port is in use

sudo lsof -i:6006

then

kill -9 <PID>

References

• Creating a React component library
• ESLint
• Publishing Node.js packages