Retargetly UI-Components

UI Components based on Design System of Retargetly for new FrontEnds.

Usage

Requirements

• Setup your Personal Access Token if you didn't do it before. HOW TO DO IT!

Installation in your project

npm install -S @retargetly/ui-components

For Development

• Run the command npm install
• To start the storybook preview npm run storybook

Build your components

• Follow the component structure
• Make your test component
• Add your component
• Style your component
• Export your API component
• Write stories on your component's variants
• Check the rules for pushing your component to the repo
• GO TO THE MOON!

To push your changes you need to do:

• Check the code format with npm run format:check. If you get any errors fix them running npm run format:fix;
• Check the code lint with npm run lint. If you have any warnings try to fix them with npm run lint:fix, and if you have any errors go ahead and check them;
• Check whether the test is passed running npm run test;
• If you had to fix anything after these checks were made, make sure to git add them, otherwise git commit will still throw errors, and Husky won't let you commit your files;
• Make your commit following the conventional commit standards