@zebrains/design-system

Установка и использование компонентов

Библиотека состоит из нескольких компонентов и инструментов, которые вы можете импортировать один за другим. Все, что вам нужно сделать, это установить @zebrains/design-system пакет

$ pnpm add @zebrains/design-system
// or
$ yarn add @zebrains/design-system
// or
$ npm install @zebrains/design-system

Для работы компонентов, необходимо так же установить react и react-dom пакеты, а для применения стилей, импортировать '@zebrains/design-system/dist/main.css' в корневом компоненте

import React from 'react';
import ReactDOM from 'react-dom';
import { Button } from '@zebrains/design-system';

import '@zebrains/design-system/dist/main.css';

ReactDOM.render(<Button>Click me!</Button>, document.getElementById('root'));

Для изучения документации и составу библиотеки компонентов, можно обратиться к следующему ресурсу Docs

Разработка

Локальный запуск документации по компонентам

pnpm i
pnpm doc:dev

После произведенной работы над бибилиотекой, необходимо повысить версию, чтобы изменения опубликовались в npm.

В зависимости от проделанных изменений надо поднять patch/minor/major версию в соответствии с правилами Семантического Версионирования.

Увеличение на 1 соответствующей версии производится с помощью команд:

pnpm version:patch

pnpm version:minor

pnpm version:major