Дизайн-система Consta | Header

Как использовать

Установите пакет

# NPM
$ npm install @consta/table

# Yarn
$ yarn add @consta/table

Подключите зависимости

Чтобы начать работу, установите библиотеку @consta/uikit и настройте тему.

Можно использовать компоненты

Например, так:

import { Theme, presetGpnDefault } from '@consta/uikit/Theme'
import { Header } from '@consta/header'

const App = () => {
  return (
    <Theme preset={presetGpnDefault}>
      <Header />
    </Theme>
  )
}

Разработка

Подготовка окружения

Рабочее окружение должно содержать NodeJS и Yarn, необходимые версии можно узнать в файле package.json в блоке engines.

Чтобы установить зависимости, выполните команду:

$ yarn install

Основные команды

# Сборка и старт Storybook
$ yarn start

# Сборка для production
$ yarn build

# Линтинг всех файлов
$ yarn lint

# Форматирование всех файлов prettier
$ yarn format

# Запуск юнит-тестов
$ yarn unit

# Запуск юнит-тестов, тестирование TS, линтинг файлов
$ yarn test

Документация

Посмотреть документацию и примеры

Контрибьюторам

Будем рады, если вы захотите принять участие в разработке дизайн-системы =) Но сначала прочитайте инструкцию для контрибьюторов.

Лицензия

Дизайн-систему можно использовать бесплатно, она распространяется ПАО «Газпром нефть» на условиях открытой лицензии MIT.