Getting started

In order to run the project you will need to make sure that you have yarn installed. It must be higher than 1.22 in order to do that you must have corepack enabled. Do not just run "npm i" to install dependencies, all packages must be installed with yarn.

1. Install yarn
2. From the project root dir, run yarn or yarn install to install dependencies
3. To start the project run yarn dev (the project should automatically run in the browser)

Merging and Publishing

1. After MR is approved, type shipit in the comments. Wait for shipit to merge your branch.
2. After your changes have been merged to master, switch to the master branch and pull down the new changes.
3. Run npm publish --dry-run.
4. If the dry run works, go ahead and run npm publish. Look for something like '@kyper/[email protected]' in the terminal output. Copy it and paste it to the end of git tag ex: git tag @kyper/[email protected]in the terminal. After that, run git push origin --tags and you're done.

Kyper library based on Material UI

The QA storybook containing the latest changes is accessible here.

Teams are currently adding components as needed, so the list in storybook right now is what has been built so far. There are some components that are not specific to MUI, it is a custom component (ex. category icons, institution logos, and merchant logos)

Type: Created our own text component to keep things more simple and using MUI behind the scenes

Icons: we decided to use material symbol icons, which is an icon font with different controls. Calling the icon by name, and adding props for different control specificity.

#Getting Started In order to start using Kyper MUI, you will need these four packages: @mui/material @emotion/react @emotion/styled @kyper/mui