catlab-ui-personal

catlab-ui

Catalyst Lab React Design System UI Components

Onboarding

Set Up

Storybook runs through docker & docker-compose

1. git checkout develop
2. docker-compose run www yarn install
3. docker-compose up
4. go to http://localhost:3000

Updating

1. git checkout develop
2. git pull
3. docker-compose run www yarn install
4. docker-compose up
5. go to http://localhost:3000

Publishing

Standard, strict semver is followed. A change is considered backwards incompatible if the components affected are no longer the 'same' visually, even if the props & type signatures are all the same.

Branching is standard git flow

Steps to publish a new build:

1. create release or hotfix branch
2. bump the version number in the package.json & commit
3. run yarn run build & commit
4. finish hotfix/release branch & git push origin develop master --tags

Usage

1. Add font CDN link to header

   <link href="https://fonts.googleapis.com/css2?family=Montserrat:ital,wght@0,400;0,500;0,600;0,700;0,800;0,900;1,400;1,500;1,700;1,800;1,900&display=swap" rel="stylesheet">
   

2. Do more stuff

Netlify storybook URL

https://design-system.uppley.education/ https://design-system.edumap.education/