@kyburz/kdesign-system

KDesignSystem

Install

npm i @kyburz/kdesign-system

Run storybook

Install the dependencies from package.json:

yarn install

Then run storybook with yarn:

yarn storybook

Release storybook

1. Merge your branch to master
2. Increment version in package.json (line 3)
3. Run npm run release (it'll ask you to login to NPM locally)
4. Commit file package.json to save new version
5. 🎉

Link to package on NPM

How to test changes in the Design System without publishing new version

1. Increment version in package.json (line 3)
2. Run yarn build:lib to make a build
3. Copy dist folder in the root of kdesign-system, go to the project fleet_frontend_v2 (or else) and replace old dist folder with new one (path /node_modules/kyburz/kdesign-system/dist)
4. Increment version of @kyburz/kdesign-system package in package.json file in project fleet_frontend_v2
5. Start fleet_frontend_v2 - changes should apply. If it's not working try to clean yarn cache

Theme Setup

import React from 'react';
import ReactDOM from 'react-dom';
import App from './App';

import { ThemeProvider } from '@mui/styles';
import { theme } from '@kyburz/kdesign-system';
import 'typeface-roboto';

ReactDOM.render(
  <ThemeProvider theme={theme}>
    <App />
  </ThemeProvider>,
  document.getElementById('root')
);

Try it out on Storybook

http://kyburzstorybook.s3-website-eu-west-1.amazonaws.com/?path=/docs/