front-package-ui-kit

Front Package UI Kit

Компонентная библиотека UI для проекта, предоставляющая переиспользуемые React-компоненты и стили.

Содержание

• Описание
• Установка и использование
• Скрипты
  • Публикация и сборка
  • Запуск Storybook
  • Создание компонентов
• Поддержка браузеров

Описание

Проект представляет собой UI Kit, созданный на базе React и TypeScript, с использованием Storybook для документирования компонентов и Webpack для сборки.

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

Чтобы использовать UI Kit в вашем проекте, добавьте его в зависимости:

npm install front-package-ui-kit

Импортируйте компоненты из библиотеки в свой проект:

import { Button } from 'front-package-ui-kit';

Скрипты

Публикация и сборка

• Сборка и публикация
  Собирает проект, увеличивает версию и публикует новую версию в npm.

  npm run pub

• Сборка
  Собирает проект в папку dist.

  npm run build

Запуск Storybook

Storybook предоставляет интерактивную среду для разработки и тестирования компонентов.

• Установка зависимостей

  npm i --legacy-peer-deps

• Запуск Storybook
  Запускает Storybook в режиме разработки на http://localhost:6006.

  npm run sb

• Сборка Storybook
  Собирает Storybook в статические файлы, которые можно развернуть на сервере.

  npm run build-storybook

Создание компонентов

Скрипт для генерации новых компонентов с использованием generate-react-cli.

• Создание нового компонента
  Создаёт шаблон компонента в папке src/components.

  npm run component ComponentName

Поддержка браузеров

Проект настроен для поддержки 99.5% современных браузеров. Настройки указаны в browserslist:

"browserslist": [
  "cover 99.5%"
]