redmine-ui-kit

Project Setup

yarn install

Compile and Hot-Reload for Development

yarn dev

Type-Check, Compile and Minify for Production

yarn build

Run Unit Tests

yarn test:unit

Lint with

yarn lint

Compile and Hot-Reload for storybook development

yarn storybook

Build storybook

yarn build-storybook

Rules for writing commits

Commits should be of the form:

<type>(optional area): <short description>

For example,

chore: adding a commit message linter

Types

The following types are allowed in the name:

• chore - updating routine tasks, etc.; without changing the production code
• feat - new feature for user
• fix - bug fix for users
• refactor - production code refactoring
• style - add or change styling for pages
• test - adding missing tests, test refactoring; without changing the production code
• docs - documentation update

Optional area

In the optional area, you can add something specific to a particular commit, such as a link to an issue.

docs(<https://example.task.tracker.com/task-42>): added optional parameter to commit message

Styles

Библиотека содержит набор глобальных переменных содержащих цветовые схемы, которые можно переназначить в родительском проекте.

Список переменных и их значений по умолчанию:

--uikit-color-text: #3E4259;
--uikit-color-white: #FFFFFF;
--uikit-color-background: #FFFFFF;
--uikit-color-accent-500: #1F7DCA;
--uikit-color-accent-300: #358CD3;
--uikit-color-black-500: #333333;
--uikit-color-green-500: #62C052;
--uikit-color-green-300: #82C277;
--uikit-color-grey-500: #C1C5D4;
--uikit-color-grey-300: #E1E3EB;
--uikit-color-red-500: #F01B28;
--uikit-color-red-300: #FFB7BC;
--uikit-color-yellow-500: #EFCF32;
--uikit-color-shadow: rgba(0, 0, 0, 30%);